unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Mark Harig <idirectscm@aim.com>
Cc: 38996@debbugs.gnu.org
Subject: bug#38996: 26.3; Missing documentation for `list-at-point' function in elisp manual.
Date: Tue, 07 Jan 2020 18:18:02 +0200	[thread overview]
Message-ID: <83imlnckat.fsf@gnu.org> (raw)
In-Reply-To: <258277221.7485058.1578342795150@mail.yahoo.com> (bug-gnu-emacs@gnu.org)

> Date: Mon, 6 Jan 2020 20:33:15 +0000 (UTC)
> From: Mark Harig via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> The NEWS file for Emacs 26.2/.3 documents changes to `thing-at-point', including mention of the function
> `list-at-point'.  C-h f (describe-function) provides documentation of `list-at-point', but C-h S
> (info-lookup-symbol) for `list-at-point' responds with "Not documented as a symbol: list-at-point'.  A check of
> the node in the elisp manual that documents `thing-at-point' does not show any mention of `list-at-point', nor
> does the previous node ("Near Point").  If `list-at-point' is documented elsewhere in the elisp manual, then an
> index manual entry is needed for this function.  Without this documentation, it is still possible to use
> `list-at-point', but when it is not documented in the manual, users might not know that it exists.

Thank you for your report.

We don't document every function in the manual: that would make the
manual too large (it already prints as 2 very thick volumes).  This
function is new, and has no callers inside Emacs, so whether it is
important enough to warrant a place in the manual remains to be seen.

For discoverability, we rely on built-in Help features such as
'apropos', and yes, on people reading NEWS when they start using a new
version, because reading that will tell them about changes in a much
more efficient way than the same information buried among many
hundreds of pages of the manual.

So I think we should wait and see if this function needs to be added
to the manual.





  reply	other threads:[~2020-01-07 16:18 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <258277221.7485058.1578342795150.ref@mail.yahoo.com>
2020-01-06 20:33 ` bug#38996: 26.3; Missing documentation for `list-at-point' function in elisp manual Mark Harig via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-01-07 16:18   ` Eli Zaretskii [this message]
2020-01-08 10:11     ` Stefan Kangas
2020-01-08 17:50   ` Mark Harig via Bug reports for GNU Emacs, the Swiss army knife of text editors
2020-01-08 18:17     ` Eli Zaretskii

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=83imlnckat.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=38996@debbugs.gnu.org \
    --cc=idirectscm@aim.com \
    /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).