unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Andrea Corallo <acorallo@gnu.org>
Cc: akrl@sdf.org, emacs-devel@gnu.org
Subject: Re: Inferred function types in the *Help* buffer
Date: Thu, 01 Jun 2023 11:53:15 +0300	[thread overview]
Message-ID: <83v8g7d0n8.fsf@gnu.org> (raw)
In-Reply-To: <yp18rd3o9pg.fsf@fencepost.gnu.org> (message from Andrea Corallo on Thu, 01 Jun 2023 04:42:03 -0400)

> 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	other threads:[~2023-06-01  8:53 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-23 16:44 Inferred function types in the *Help* buffer Andrea Corallo
2023-05-24 10:46 ` Eli Zaretskii
2023-05-24 12:19   ` Andrea Corallo
2023-05-30 16:46     ` Andrea Corallo
2023-05-30 18:14       ` Mattias Engdegård
2023-05-30 18:48         ` Andrea Corallo
2023-05-31 12:19           ` Andrea Corallo
2023-05-31 14:08             ` Eli Zaretskii
2023-06-01 11:28             ` Mattias Engdegård
2023-06-01 11:35               ` Eli Zaretskii
2023-06-01 11:36                 ` Mattias Engdegård
2023-06-01 11:54                   ` Andrea Corallo
2023-06-01 11:50               ` Andrea Corallo
2023-06-01 13:06                 ` Mattias Engdegård
2023-06-01 13:34                   ` Andrea Corallo
2023-06-01 14:50                     ` Mattias Engdegård
2023-06-01 15:10                       ` Andrea Corallo
2023-06-01 17:53                         ` Mattias Engdegård
2023-06-01 19:13                           ` Andrea Corallo
2023-06-01 14:09                   ` Andrea Corallo
2023-05-31 13:46       ` Eli Zaretskii
2023-06-01  8:42         ` Andrea Corallo
2023-06-01  8:53           ` Eli Zaretskii [this message]
  -- strict thread matches above, loose matches on Subject: below --
2023-05-23 16:47 Payas Relekar
2023-05-23 18:51 ` Philip Kaludercic
2023-05-24 12:20 ` Andrea Corallo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83v8g7d0n8.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=acorallo@gnu.org \
    --cc=akrl@sdf.org \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).