Month comparators documentation.

This commit is contained in:
Dominik Pantůček 2023-03-22 21:09:47 +01:00
parent a17b59d241
commit acb1e8cd0a

View file

@ -121,7 +121,7 @@ inclusive. Returns boolean value.
Parses given string ```s``` as month and constructs a month value from Parses given string ```s``` as month and constructs a month value from
the YYYY and MM components parsed. The resulting month value is the YYYY and MM components parsed. The resulting month value is
returned only if it is valid. Otherwise #f is returned. returned only if it is valid. Otherwise ```#f``` is returned.
(month->string m) (month->string m)
@ -133,6 +133,49 @@ If ```#f```, returns a special empty month result ```"____-__"```.
Raises an error if ```m``` is not a valid month. Raises an error if ```m``` is not a valid month.
(month=? m n)
* ```m``` - first valid month value
* ```n``` - second valid month value
Returns ```#t``` if both month values are valid and ```equal?```.
(month<? m n)
* ```m``` - first valid month value
* ```n``` - second valid month value
Returns ```#t``` if both month values are valud and ```m``` comes
before ```n``` in the calendar.
(month<=? m n)
* ```m``` - first valid month value
* ```n``` - second valid month value
Returns ```#t``` if both month values are valud and ```m``` comes
before ```n``` in the calendar or they are ```equal?```.
(month>=? m n)
* ```m``` - first valid month value
* ```n``` - second valid month value
Returns ```#t``` if both month values are valud and ```m``` comes
after ```n``` in the calendar or they are ```equal?```.
(month>? m n)
* ```m``` - first valid month value
* ```n``` - second valid month value
Returns ```#t``` if both month values are valud and ```m``` comes
after ```n``` in the calendar.
month-diff
month-add
### Period ### Period
### Primes ### Primes