[m-dev.] documenting typed insts

Julien Fischer jfischer at opturion.com
Wed Jan 8 12:48:50 AEDT 2020


On Wed, 8 Jan 2020, Zoltan Somogyi wrote:

> 2020-01-07 20:10 GMT+11:00 Zoltan Somogyi<zoltan.somogyi at runbox.com>:
>> I could add both an entry to NEWS and a paragraph or two to reference_manual.texi
>> about the feature saying only that it is intended to tell to *humans* what type
>> an inst is for, and that in the future we may check this automatically. For now,
>> the compiler does no such check.
>
> The attached diff does this. For review by anyone.

...

> Announce the "inst for type constructor" extension of inst syntax.
> NEWS:
>     As above.

...

> diff --git a/doc/reference_manual.texi b/doc/reference_manual.texi
> index 8df6bc5..3c39188 100644
> --- a/doc/reference_manual.texi
> +++ b/doc/reference_manual.texi

...

> @@ -2972,16 +2972,31 @@ for @code{bound} instantiatedness trees:
>  @example
>  :- inst maybeskel
>      --->    no
> -    ;       yes(ground).
> +    ;       yes(free).
>  @end example
>
>  @noindent
>  which is equivalent to writing
>
>  @example
> -:- inst maybeskel == bound(no ; yes(ground)).
> +:- inst maybeskel == bound(no ; yes(free)).
>  @end example
> 
> +You can specify what type (actually what type constructor)
> +an inst intended to be used on

Add "is" after inst.

The rest looks fine - thanks for that!

Julien.


More information about the developers mailing list