[m-rev.] Bug in API documentation

Julien Fischer jfischer at opturion.com
Tue Nov 11 09:38:54 AEDT 2025


Hi Volker,

On Mon, 10 Nov 2025 at 18:07, Volker Wysk <post at volker-wysk.de> wrote:

> In the documentation of the multi_map module is this:
>
>     % If the multi_map has an entry for the given key,
>     % succeed once for each of the corresponding values.
>     % Otherwise, throw an exception.
>     %
> :- func lookup(multi_map(K, V), K) = list(V).
> :- pred lookup(multi_map(K, V)::in, K::in, list(V)::out) is det.
>
> The comment doesn't match the declaration.

Thanks for reporting that. It's a copy-and-paste error. That's the documentation
for nondet_lookup/3 directly below.  (The same thing occurs in the
one_or_more_map
as well.)

Julien.


More information about the reviews mailing list