GNU bug report logs - #38996
26.3; Missing documentation for `list-at-point' function in elisp manual.

Previous Next

Full log

View this message in rfc822 format

From: Mark Harig <idirectscm <at> aim.com>
To: 38996 <at> 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)

[Message part 1 (text/plain, inline)]

> 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.
---

[Message part 2 (text/html, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.