org-parse-time-string: Describe time stamp matching behavior

* lisp/org-macs.el (org-parse-time-string): Document matching of
YYYY-MM-DD substring.

org-clock-special-range used to pass in <-50001-11-30 Tue 00:00> with
the expectation that the year would be parsed as -50001, not 0001.
Mention this YYYY-MM-DD format assumption in the docstring to help
avoid such cases.
This commit is contained in:
Kyle Meyer 2018-12-28 15:23:00 -05:00
parent 9ceb723602
commit c11b147d1d
1 changed files with 3 additions and 1 deletions

View File

@ -1112,7 +1112,9 @@ nil, just return 0."
If time is not given, defaults to 0:00. However, with optional
NODEFAULT, hour and minute fields are nil if not given.
Throw an error if S in not a valid Org time string.
Throw an error if S does not contain a valid Org time string.
Note that the first match for YYYY-MM-DD will be used (e.g.,
\"-52000-02-03\" will be taken as \"2000-02-03\").
This should be a lot faster than the `parse-time-string'."
(unless (string-match org-ts-regexp0 s)