org-duration: Small docstring improvement

* lisp/org-duration.el (org-duration-format): Remove ambiguous
  reference to a "next smallest unit".  Reword REQUIRED? description.
This commit is contained in:
Nicolas Goaziou 2017-04-29 10:37:39 +02:00
parent 75320ff205
commit b60edc480d
1 changed files with 3 additions and 5 deletions

View File

@ -116,12 +116,10 @@ pattern:
UNIT is a unit string, as defined in `org-duration-units'. The
time duration is formatted using only the time components that
are specified here. If a time unit in missing, it falls back to
the next smallest unit.
are specified here.
A non-nil REQUIRED? value for these keys indicates that the
corresponding time component should always be included, even if
its value is 0.
Units with a zero value are skipped, unless REQUIRED? is non-nil.
In that case, the unit is always used.
Eventually, the list can contain one of the following special
entries: