From: Mark Harig via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: 38996@debbugs.gnu.org
Subject: bug#38996: 26.3; Missing documentation for `list-at-point' function in elisp manual.
Date: Wed, 8 Jan 2020 17:50:16 +0000 (UTC) [thread overview]
Message-ID: <856796400.8608681.1578505816990@mail.yahoo.com> (raw)
In-Reply-To: <258277221.7485058.1578342795150@mail.yahoo.com>
[-- Attachment #1: Type: text/plain, Size: 1075 bytes --]
> 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.
OK. Going forward, how are end users to know which functions have notbeen documented on purpose and which have not been documented due tooversight? It might be worth considering adding to future NEWS, whena new function or variable is added, a some brief note saying that"this function/variable will not (yet) be documented in one of themanuals." Without that, it is impossible for a user to know whetherthe lack of documentation is intentional or an error to be reported here.
---
[-- Attachment #2: Type: text/html, Size: 2350 bytes --]
next prev parent reply other threads:[~2020-01-08 17:50 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
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 [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=856796400.8608681.1578505816990@mail.yahoo.com \
--to=bug-gnu-emacs@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.