From efa005066957e8871b05efbe94c4113880e0a282 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Mon, 22 May 2023 20:35:38 +0200 Subject: [PATCH] Document cal-period extended behavior when handling mixture of cal-day and cal-month periods. --- doc/calendar.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/calendar.md b/doc/calendar.md index 1b99601..76a4c3d 100644 --- a/doc/calendar.md +++ b/doc/calendar.md @@ -214,11 +214,13 @@ end-month)```. (cal-month-in-period? p [m (*current-month*)]) -* ```p``` - a periods -* ```m``` - a valid month - defaults to ```(*current-month*)``` +* ```p``` - a period structure +* ```m``` - a valid month or day - defaults to ```(*current-month*)``` Returns ```#t``` if given month ```m``` lies within the period -```p```. +```p```. The period can be cal-day or cal-month period and is +converted to appropriate cal-month period before checking. If ```m``` +is a cal-day, it is converted to cal-month before testing. (cal-month-in-periods? ps [m (*current-month*)])