From a5afb25dd7546adcf31eb3913d4fca780bb63782 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Tue, 4 Jul 2023 20:54:24 +0200 Subject: [PATCH] Remove old static util-time documentation. --- doc/d-utils.md | 13 +++++++++++-- doc/utils.md | 22 ---------------------- src/util-time.scm | 13 +++++++++++-- 3 files changed, 22 insertions(+), 26 deletions(-) diff --git a/doc/d-utils.md b/doc/d-utils.md index e11f8f5..ec2be2e 100644 --- a/doc/d-utils.md +++ b/doc/d-utils.md @@ -6,13 +6,22 @@ These are various utility modules for other HackerBase libraries. (import util-time) -Compatibility time module for <5.2 and >=5.3 versions of CHICKEN. +Compatibility module for the differences between chicken scheme +version 5.2 and earlier and 5.3 and on. ### current-util-milliseconds [procedure] (current-util-milliseconds) -Returns the current milliseconds counter that can be used for high-precision time measurements. +Returns the number of milliseconds since process startup. + +Under chicken scheme <5.3 it uses ```current-milliseconds``` and for +chicken scheme >=5.3 it uses ```current-process-milliseconds```. + +Without this module compilation with ```current-milliseconds``` +results in warnings on chicken scheme >=5.3 and compilation under +chicken scheme <5.3 results in error with +```current-process-milliseconds```. ### seconds->iso-date-string [procedure] diff --git a/doc/utils.md b/doc/utils.md index 7f5127a..328015c 100644 --- a/doc/utils.md +++ b/doc/utils.md @@ -529,25 +529,3 @@ A unifying module for compound data structures tagging. Creates a unique and collision free symbol to identify compound data structures based on lists and pairs. -### Time - - (import util-time) - -Compatibility module for the differences between chicken scheme -version 5.2 and earlier and 5.3 and on. - - (current-util-milliseconds) - -Returns the number of milliseconds since process startup. - -Under chicken scheme <5.3 it uses ```current-milliseconds``` and for -chicken scheme >=5.3 it uses ```current-process-milliseconds```. - -Without this module compilation with ```current-milliseconds``` -results in warnings on chicken scheme >=5.3 and compilation under -chicken scheme <5.3 results in error with -```current-process-milliseconds```. - - (today/iso) - -Returns the current date as string in ISO YYYY-MM-DD format. diff --git a/src/util-time.scm b/src/util-time.scm index 441d105..79a4a88 100644 --- a/src/util-time.scm +++ b/src/util-time.scm @@ -29,7 +29,8 @@ (module* util-time - #:doc ("Compatibility time module for <5.2 and >=5.3 versions of CHICKEN.") + #:doc ("Compatibility module for the differences between chicken scheme +version 5.2 and earlier and 5.3 and on.") ( current-util-milliseconds @@ -43,7 +44,15 @@ (chicken format)) (define/doc (current-util-milliseconds) - ("Returns the current milliseconds counter that can be used for high-precision time measurements.") + ("Returns the number of milliseconds since process startup. + +Under chicken scheme <5.3 it uses ```current-milliseconds``` and for +chicken scheme >=5.3 it uses ```current-process-milliseconds```. + +Without this module compilation with ```current-milliseconds``` +results in warnings on chicken scheme >=5.3 and compilation under +chicken scheme <5.3 results in error with +```current-process-milliseconds```.") (cond-expand (chicken-5.0 (current-milliseconds))