From cf4211d1ba381f4c1343a16f70faebbcca138eb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Tue, 4 Jul 2023 20:52:42 +0200 Subject: [PATCH] Finish util-time documentation. --- doc/d-utils.md | 8 +++++++- src/util-time.scm | 7 +++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/d-utils.md b/doc/d-utils.md index ba7d0c8..e11f8f5 100644 --- a/doc/d-utils.md +++ b/doc/d-utils.md @@ -18,4 +18,10 @@ Returns the current milliseconds counter that can be used for high-precision tim (seconds->iso-date-string . args) -Converts given seconds to ISO date string. Defaults to ```(current-seconds)```. +Converts given seconds to ISO date string YYYY-MM-DD. Defaults to ```(current-seconds)```. + +### today/iso [procedure] + + (today/iso) + +Returns today as ISO date string YYYY-MM-DD. diff --git a/src/util-time.scm b/src/util-time.scm index 0d96b18..441d105 100644 --- a/src/util-time.scm +++ b/src/util-time.scm @@ -55,7 +55,7 @@ (current-process-milliseconds)))) (define/doc (seconds->iso-date-string . args) - ("Converts given seconds to ISO date string. Defaults to ```(current-seconds)```.") + ("Converts given seconds to ISO date string YYYY-MM-DD. Defaults to ```(current-seconds)```.") (let ((d (apply seconds->local-time args))) (format "~A-~A-~A" (number->string @@ -69,9 +69,8 @@ (+ 100 (vector-ref d 3))) 1)))) - ;;; Returns today as YYYY-MM-DD string - (define (today/iso) + (define/doc (today/iso) + ("Returns today as ISO date string YYYY-MM-DD.") (seconds->iso-date-string)) ) -