From dd6722fe13144ed7981079ac4271e576c73acb63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Wed, 22 Mar 2023 22:42:08 +0100 Subject: [PATCH] Finish month module documentation. --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 462f3a4..74e69be 100644 --- a/README.md +++ b/README.md @@ -172,9 +172,22 @@ after ```n``` in the calendar or they are ```equal?```. Returns ```#t``` if both month values are valud and ```m``` comes after ```n``` in the calendar. -month-diff + (month-diff f t) -month-add +* ```f``` - valid month (from) +* ```t``` - valid month (to) + +Returns the difference in months from month ```f``` to month +```t```. If both months are the same, the result is zero. If ```t``` +is before ```f```, the result is negative. + + (month-add m n) + +* ```m``` - valid month +* ```n``` - an integer + +Returns a new valid month that comes ```n``` months after ```m```. If +```n``` is negative, it correctly subtracts the months. ### Period