From: phillip.lord@russet.org.uk (Phillip Lord)
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 17:34:54 +0000 [thread overview]
Message-ID: <87si3jo2pt.fsf@russet.org.uk> (raw)
In-Reply-To: <m2d1unil3q.fsf@newartisans.com> (John Wiegley's message of "Thu, 3 Dec 2015 10:54:17 -0500")
John Wiegley <jwiegley@gmail.com> writes:
> <#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.
Yeah, think that's true. I made them internal but then when I was
writing the documentation thought perhaps they should be documented.
Deciding what is "end-user" functionality and what is "implementation"
gets a bit hard when you are talking about code of this form.
I'll patch them up and make these two non internal.
Phil
next prev parent reply other threads:[~2015-12-03 17:34 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
2015-12-03 17:34 ` Phillip Lord [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87si3jo2pt.fsf@russet.org.uk \
--to=phillip.lord@russet.org.uk \
--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 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.