[m-rev.] for review: extend documentation of calendar/same_date/2

[Zoltan Somogyi]

On Sat, 28 Mar 2026 22:28:11 +1100, Julien Fischer <jfischer at opturion.com> wrote:
> For review by anyone.
> 
> Extend the documentation of calendar.same_date/2.
> 
> library/calender.m:
>     In particular, add a reminder that the reuslt are only meaningful if the
>     two arguments are date_times in the same time zone.

s/reuslt/result/

> Julien.
> 
> diff --git a/library/calendar.m b/library/calendar.m
> index 05128b5d0..7d91e24e4 100644
> --- a/library/calendar.m
> +++ b/library/calendar.m
> @@ -277,7 +277,10 @@
>      % same_date(A, B):
>      %
>      % Succeed if-and-only-if A and B refer to the exact same day.
> -    % Their time components are ignored.
> +    % Their time components are ignored. A and B should refer to
> +    % the same time zone; comparing dates in different time zones
> +    % may give incorrect results because the same point in time can
> +    % fall on different days in different time zones.

I would add a comma before "because".

The diff is otherwise fine.

If you intend to do more of these kinds of changes, I think it would be
simpler if you posted them for *post-commit* review. I could then make
these changes in the files themselves, which is faster than describing
the changes in email.

Zoltan.

Zoltan.