emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Inferred function types in the *Help* buffer


From: Eli Zaretskii
Subject: Re: Inferred function types in the *Help* buffer
Date: Thu, 01 Jun 2023 11:53:15 +0300

> From: Andrea Corallo <acorallo@gnu.org>
> Cc: akrl@sdf.org,  emacs-devel@gnu.org
> Date: Thu, 01 Jun 2023 04:42:03 -0400
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> >   ** Help
> >   ** 'describe-function' shows function inferred type when available.
> >   For native compiled Lisp functions 'describe-function' prints (after
> >   the signature) the automatically inferred function type as well.
> >
> > Is IMO too terse.  "Inferred type" is terminology we didn't use and
> > don't explain the manual, so the above doesn't really tell what kind
> > of information is displayed.  We should give a hint, and perhaps have
> > more details in the ELisp manual, probably as part of documenting
> > subr-type.
> 
> Okay, I think I need some advise on where to get started on this so this
> weekend I can try to put some effort on.  Where should we add the
> documentation for subr-type in the manual?

I think in "What Is a Function", where we document subrp and
subr-arity.

If you don't feel like writing the final text, complete with markup
and all, just post the raw text, and I will do the rest.

Thanks.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]