update gfn file

atecon · Oct 12, 2021 · 78bc76b · 78bc76b
1 parent 02c9883
commit 78bc76b
Showing 1 changed file with 14 additions and 5 deletions.
diff --git a/src/calendar_utils.gfn b/src/calendar_utils.gfn
@@ -3,7 +3,7 @@
 <gretl-function-package name="calendar_utils" no-data-ok="true" minver="2020c">
 <author email="atecon@posteo.de">Artur Tarassow</author>
 <version>0.3</version>
-<date>2021-10-06</date>
+<date>2021-10-12</date>
 <description>Collection of useful date time related tools</description>
 <tags>C88</tags>
 <help>
@@ -34,11 +34,12 @@ gretl's built-in functions strptime() and strftime() are used. See the help on
 these functions for more details.
 
 WARNING: Before gretl 2021e, there was a gretl bug in strptime() when the date
-format passed did not consist of a month and day component, respectively.
-See here:
+format passed did not consist of a month and day component, respectively. This
+bug leads to a wrong date returned. See here:
 https://gretlml.univpm.it/hyperkitty/list/gretl-devel@gretlml.univpm.it/message/6ENWKDGSYB32ZFKHENLPFJSS3X22JGYB/
-We recommend users not to pass the date e.g. as &quot;1984&quot; but rather in the format
-&quot;1984-01-01&quot; or to wait for the next gretl version after 2021d.
+To ensure correct results the caller should fully specify the input date,
+including month and day of month (and month, day should also be present in the
+format given).
 -----------------------------------------------------------------------
 
 -----------------------------------------------------------------------
@@ -51,6 +52,14 @@ date_format:    string, Format of 'dates', e.g. &quot;%Y-%m-%d&quot;
 
 Return:
 Series holding cast values of 'dates' in the numeric ISO8601 format (YYYYMMDD).
+
+WARNING: Before gretl 2021e, there was a gretl bug in strptime() when the date
+format passed did not consist of a month and day component, respectively. This
+bug leads to a wrong date returned. See here:
+https://gretlml.univpm.it/hyperkitty/list/gretl-devel@gretlml.univpm.it/message/6ENWKDGSYB32ZFKHENLPFJSS3X22JGYB/
+To ensure correct results the caller should fully specify the input date,
+including month and day of month (and month, day should also be present in the
+format given).
 -----------------------------------------------------------------------
 
 -----------------------------------------------------------------------