* Re: [Emacs-diffs] trunk r115961: Document `subr-x' functions.
[not found] <E1W1bSL-0003KG-4g@vcs.savannah.gnu.org>
@ 2014-01-10 15:22 ` Stefan Monnier
2014-01-10 16:22 ` Bozhidar Batsov
2014-01-10 16:26 ` Rüdiger Sonderfeld
0 siblings, 2 replies; 7+ messages in thread
From: Stefan Monnier @ 2014-01-10 15:22 UTC (permalink / raw)
To: Rüdiger Sonderfeld, emacs-devel
> Document `subr-x' functions.
Please don't. The Elisp manual is already very large, we don't want to
document everything in it.
Stefan
^ permalink raw reply [flat|nested] 7+ messages in thread* Re: [Emacs-diffs] trunk r115961: Document `subr-x' functions.
2014-01-10 15:22 ` [Emacs-diffs] trunk r115961: Document `subr-x' functions Stefan Monnier
@ 2014-01-10 16:22 ` Bozhidar Batsov
2014-01-10 17:24 ` Stefan Monnier
2014-01-10 16:26 ` Rüdiger Sonderfeld
1 sibling, 1 reply; 7+ messages in thread
From: Bozhidar Batsov @ 2014-01-10 16:22 UTC (permalink / raw)
To: Stefan Monnier; +Cc: Rüdiger Sonderfeld, emacs-devel
[-- Attachment #1: Type: text/plain, Size: 473 bytes --]
There should be some guidelines about what needs documenting and what
doesn't. Personally, I feel that hash and string related functions are
worth documenting, as many people are likely learning Elisp by reading the
Elisp manual.
On 10 January 2014 17:22, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
> > Document `subr-x' functions.
>
> Please don't. The Elisp manual is already very large, we don't want to
> document everything in it.
>
>
> Stefan
>
>
[-- Attachment #2: Type: text/html, Size: 887 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Emacs-diffs] trunk r115961: Document `subr-x' functions.
2014-01-10 16:22 ` Bozhidar Batsov
@ 2014-01-10 17:24 ` Stefan Monnier
2014-01-10 17:40 ` Bozhidar Batsov
0 siblings, 1 reply; 7+ messages in thread
From: Stefan Monnier @ 2014-01-10 17:24 UTC (permalink / raw)
To: Bozhidar Batsov; +Cc: Rüdiger Sonderfeld, emacs-devel
> There should be some guidelines about what needs documenting and what
> doesn't. Personally, I feel that hash and string related functions are
> worth documenting, as many people are likely learning Elisp by reading the
> Elisp manual.
subr-x functions are functions which haven't yet proved useful enough to
deserve to be in subr.el, so for the same reason I don't think they
belong in the Lispref either.
Stefan
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [Emacs-diffs] trunk r115961: Document `subr-x' functions.
2014-01-10 15:22 ` [Emacs-diffs] trunk r115961: Document `subr-x' functions Stefan Monnier
2014-01-10 16:22 ` Bozhidar Batsov
@ 2014-01-10 16:26 ` Rüdiger Sonderfeld
2014-01-10 17:22 ` Stefan Monnier
1 sibling, 1 reply; 7+ messages in thread
From: Rüdiger Sonderfeld @ 2014-01-10 16:26 UTC (permalink / raw)
To: emacs-devel; +Cc: Stefan Monnier
On Friday 10 January 2014 10:22:51 Stefan Monnier wrote:
> > Document `subr-x' functions.
>
> Please don't. The Elisp manual is already very large, we don't want to
> document everything in it.
They weren't marked "---" in NEWS and the hash-table functions were already
documented. Right now `subr-x' is too small to deserve a separate manual.
Maybe not every function should be documented but there should be at least a
hint in the manual to make it more discoverable.
Shall I revert the patch?
Regards,
Rüdiger
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2014-01-10 17:58 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <E1W1bSL-0003KG-4g@vcs.savannah.gnu.org>
2014-01-10 15:22 ` [Emacs-diffs] trunk r115961: Document `subr-x' functions Stefan Monnier
2014-01-10 16:22 ` Bozhidar Batsov
2014-01-10 17:24 ` Stefan Monnier
2014-01-10 17:40 ` Bozhidar Batsov
2014-01-10 16:26 ` Rüdiger Sonderfeld
2014-01-10 17:22 ` Stefan Monnier
2014-01-10 17:58 ` Rüdiger Sonderfeld
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).