From: Tassilo Horn <tsdh@gnu.org>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: Eli Zaretskii <eliz@gnu.org>,
liwei.ma@gmail.com, kevin.legouguec@gmail.com,
emacs-devel@gnu.org
Subject: Re: When will emacs 27.1 be officially released?
Date: Thu, 02 Jul 2020 22:29:13 +0200 [thread overview]
Message-ID: <87366964py.fsf@gnu.org> (raw)
In-Reply-To: <93bffae8-e8e5-2eea-7087-5a894cbfea0c@cs.ucla.edu> (Paul Eggert's message of "Tue, 30 Jun 2020 15:17:58 -0700")
Paul Eggert <eggert@cs.ucla.edu> writes:
>>> A method that works reasonably well in other projects is to update
>>> manuals and NEWS as we go, not just before a release.
>> I started requesting that some time ago, with limited success.
>
> Is there some way we could step that up? E.g., perhaps start by
> reminding people who commit code changes but not changes to the
> corresponding documentation that they need to do the documenation
> ASAP.
It would be awesome if there was an automatic way to check if some code
I have touched is already documented in the manual and might require
adaption, i.e., diff in, links to relevant parts of the manual out. I
think it occurred to me a few times that I've added another argument to
some function, for example, and didn't even realize that this function
was documented in the manual.
What would also be nice was a way to write something like
@IncludeEmacsDefunDocs{my-function}{lisp/my.el}
which would be replaced by
@defun my-function arg
Docstring of my-function where ARG is replaced with @{arg}.
@end defun
because at least in the Elisp manual, most function and variable
descriptions are (almost) identical to the corresponding docstrings
anyway.
BTW, I just looked at the docs and it seems that in large parts the
function descriptions in the manual read
This function takes a @var{coin} and returns a @var{beer}.
(indicative) whereas the docstring reads
Take a COIN and return a BEER.
(imperative). I know the latter is our convention for function
docstrings. Is the former our convention for documenting functions in
the manual?
Bye,
Tassilo
next prev parent reply other threads:[~2020-07-02 20:29 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-30 2:52 When will emacs 27.1 be officially released? Liwei Ma
2020-06-30 3:55 ` Eli Zaretskii
2020-06-30 8:12 ` tomas
2020-06-30 9:51 ` Kévin Le Gouguec
2020-06-30 16:58 ` Eli Zaretskii
2020-06-30 18:52 ` Paul Eggert
2020-06-30 19:06 ` Eli Zaretskii
2020-06-30 22:17 ` Paul Eggert
2020-06-30 22:31 ` Dmitry Gutov
2020-07-01 0:03 ` Paul Eggert
2020-07-01 14:29 ` Eli Zaretskii
2020-07-01 17:47 ` Dmitry Gutov
2020-07-01 17:52 ` Paul Eggert
2020-07-01 17:55 ` Dmitry Gutov
2020-07-01 18:13 ` Eli Zaretskii
2020-07-01 18:16 ` Dmitry Gutov
2020-07-01 18:12 ` Eli Zaretskii
2020-07-01 14:33 ` Eli Zaretskii
2020-07-02 3:49 ` Richard Stallman
2020-07-02 13:04 ` Eli Zaretskii
2020-07-03 2:21 ` Richard Stallman
2020-07-02 20:29 ` Tassilo Horn [this message]
2020-07-02 20:36 ` Paul Eggert
2020-07-02 20:55 ` Tassilo Horn
2020-07-04 2:53 ` Richard Stallman
2020-07-04 6:41 ` Eli Zaretskii
2020-07-05 2:35 ` Richard Stallman
2020-07-05 14:33 ` Eli Zaretskii
2020-07-03 6:05 ` Eli Zaretskii
2020-07-03 7:24 ` Tassilo Horn
2020-07-03 11:59 ` Eli Zaretskii
2020-07-04 2:52 ` Richard Stallman
2020-06-30 22:09 ` Kévin Le Gouguec
2020-07-01 14:49 ` Eli Zaretskii
2020-07-02 9:00 ` Kévin Le Gouguec
2020-07-02 13:12 ` Eli Zaretskii
2020-07-02 13:44 ` Kévin Le Gouguec
2020-07-03 0:48 ` Do pretests reach end users? (was: When will emacs 27.1 be officially released?) Dmitry Alexandrov
2020-07-03 6:21 ` Eli Zaretskii
2020-07-03 9:59 ` Do pretests reach end users? Dmitry Gutov
2020-07-03 11:43 ` Eli Zaretskii
2020-07-03 20:23 ` Dmitry Gutov
2020-07-04 6:15 ` Eli Zaretskii
2020-07-04 1:31 ` Dmitry Alexandrov
2020-07-04 6:32 ` Eli Zaretskii
2020-07-05 4:18 ` Dmitry Alexandrov
2020-07-04 11:11 ` Phillip Lord
2020-07-05 4:23 ` Dmitry Alexandrov
2020-07-05 21:15 ` Phillip Lord
2020-07-05 16:55 ` Sean Whitton
2020-06-30 13:01 ` When will emacs 27.1 be officially released? Basil L. Contovounesios
2020-06-30 14:06 ` Stefan Monnier
2020-06-30 14:28 ` Eli Zaretskii
2020-06-30 14:34 ` Rostislav Svoboda
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=87366964py.fsf@gnu.org \
--to=tsdh@gnu.org \
--cc=eggert@cs.ucla.edu \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=kevin.legouguec@gmail.com \
--cc=liwei.ma@gmail.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 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).