From: John Wiegley <jwiegley@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Phillip Lord <phillip.lord@newcastle.ac.uk>, emacs-devel@gnu.org
Subject: Re: [Emacs-diffs] emacs-25 c2ba4a2: ; Added documentation for undo-auto functionality.
Date: Thu, 03 Dec 2015 10:54:17 -0500 [thread overview]
Message-ID: <m2d1unil3q.fsf@newartisans.com> (raw)
In-Reply-To: <83oaeaj5la.fsf@gnu.org> (Eli Zaretskii's message of "Tue, 01 Dec 2015 22:07:13 +0200")
<#secure method=pgpmime mode=sign>
>>>>> Eli Zaretskii <eliz@gnu.org> writes:
> This commit documents internal functions and variables. IMO, if we think
> they deserve being documented (and I think I agree), they shouldn't be
> internal in the first place.
If they're truly internal, I don't think they should be documented in
elisp.texi. Sufficient documentation is provided for such functions via the
docstring.
If one feels they do belong in elisp.texi, they shouldn't be internal, as Eli
indicates.
In a sense, elisp.texi defines our "Emacs Lisp API" to programmers, so
anything we document there represent a certain level of commitment.
--
John Wiegley GPG fingerprint = 4710 CF98 AF9B 327B B80F
http://newartisans.com 60E1 46C4 BD1A 7AC1 4BA2
next prev parent reply other threads:[~2015-12-03 15:54 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-01 20:07 [Emacs-diffs] emacs-25 c2ba4a2: ; Added documentation for undo-auto functionality Eli Zaretskii
2015-12-03 15:54 ` John Wiegley [this message]
2015-12-03 17:34 ` Phillip Lord
2015-12-03 19:51 ` Stefan Monnier
2015-12-03 21:47 ` Phillip Lord
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=m2d1unil3q.fsf@newartisans.com \
--to=jwiegley@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=phillip.lord@newcastle.ac.uk \
/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).