[m-rev.] for post-commit review: adjust documentation of the ranges module

[Julien Fischer]

On Sun, 8 Jun 2025 at 10:33, Zoltan Somogyi <zoltan.somogyi at runbox.com> wrote:
>
>
> On 2024-03-30 14:30 +11:00 AEST, "Julien Fischer" <jfischer at opturion.com> wrote:
> > On Sat, 30 Mar 2024, Zoltan Somogyi wrote:
> >

> >> If this diff is here, that means that this module does not *order*
> >> its exported predicates the same way as the other set predicates do.
> >> You may want to fix that in your next diff.
> >
> > No, it doesn't order its exported predicates as per the other set
> > modules. I intend to fix that in subsequent change.
>
> I don't think this has been done yet.

No, it hasn't.

> >>> -    % Shift a range by const C.
> >>> +    % Shift a range by a constant C.
> >>>      %
> >>>  :- func shift(ranges, int) = ranges.
> >>> -    % Dilate a range by const C.
> >>> +    % Dilate a range by a constant C.
> >>>      %
> >>>  :- func dilation(ranges, int) = ranges.
> >>> -    % Contract a range by const C.
> >>> +    % Contract a range by a constant C.
> >>>      %
> >>>  :- func contraction(ranges, int) = ranges.
> >>>
> >>
> >> I had no idea what these functions do, and still don't.
> >> And the function names don't help.
> >
> > I know; I will deal with these after I have some more extensive testing
> > of this module in place; among other things contraction appears to
> > violate the invariants of the ranges types.
>
> And these functions don't have any useful documentation yet either.

Still on my list of things to do.

Julien.