AndyTechGuy has uploaded a new change for review.
https://gerrit.wikimedia.org/r/258774
Change subject: Change documentation of formatTimePeriod
......................................................................
Change documentation of formatTimePeriod
Currently, the function formatTimePeriod does not have a very descriptive
documentation and has a TODO tag on it to change the documentation
Change the documentation to be more descriptive and remove the TODO
Change-Id: Idde711f1d3d6cbe0ecab0c3b49c68a4876d9e8b2
---
M languages/Language.php
1 file changed, 6 insertions(+), 5 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/74/258774/1
diff --git a/languages/Language.php b/languages/Language.php
index 7747198..8f4a2d5 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -4619,14 +4619,15 @@
}
/**
- * @todo Document
+ * Formats a time given in seconds into a string representation of that
time.
+ *
* @param int|float $seconds
- * @param array $format Optional
- * If $format['avoid'] === 'avoidseconds': don't mention seconds if
$seconds >= 1 hour.
- * If $format['avoid'] === 'avoidminutes': don't mention
seconds/minutes if $seconds > 48 hours.
+ * @param array $format An optional argument that will format the
returned string in different ways:
+ * If $format['avoid'] === 'avoidseconds': then don't display seconds
if $seconds >= 1 hour,
+ * If $format['avoid'] === 'avoidminutes': then don't display seconds
or minutes if $seconds > 48 hours,
* If $format['noabbrevs'] is true: use 'seconds' and friends instead
of 'seconds-abbrev'
* and friends.
- * For backwards compatibility, $format may also be one of the
strings 'avoidseconds'
+ * @note For backwards compatibility, $format may also be one of the
strings 'avoidseconds'
* or 'avoidminutes'.
* @return string
*/
--
To view, visit https://gerrit.wikimedia.org/r/258774
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Idde711f1d3d6cbe0ecab0c3b49c68a4876d9e8b2
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: AndyTechGuy <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
