From: Eli Zaretskii <eliz@gnu.org>
To: Jean-Christophe Helary <jean.christophe.helary@gmail.com>
Cc: 26925-done@debbugs.gnu.org
Subject: bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation
Date: Fri, 19 May 2017 14:47:53 +0300 [thread overview]
Message-ID: <83o9up2hli.fsf@gnu.org> (raw)
In-Reply-To: <93AB3C85-27C1-48FF-8C3D-B90B4CF33670@gmail.com> (message from Jean-Christophe Helary on Mon, 15 May 2017 00:45:34 +0900)
> From: Jean-Christophe Helary <jean.christophe.helary@gmail.com>
> Date: Mon, 15 May 2017 00:45:34 +0900
>
> I slightly changed the paragraph order in the documentation to (split-string) to make it more readable.
>
> Jean-Christophe
>
> ===========================
> Improve documentation of (split-string)
>
> * /doc/lispref/strings.texi (split-string): change paragraph
> order to improve readability.
> ===========================
Thanks, pushed.
One nit: please don't refer to functions with syntax that looks like a
function call, as in (split-string) above, or foo() for C sources.
The GNU Coding Standards frown on such references, because they look
like a call to a function with no arguments, which is not what is
meant there. We use 'split-string' and 'foo' instead, i.e. the name
of the function in quotes.
next prev parent reply other threads:[~2017-05-19 11:47 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-14 15:45 bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation Jean-Christophe Helary
2017-05-19 11:47 ` Eli Zaretskii [this message]
2017-05-19 12:23 ` Jean-Christophe Helary
2017-05-19 12:56 ` Eli Zaretskii
2017-05-19 13:02 ` Jean-Christophe Helary
2017-05-19 13:30 ` Stephen Berman
2017-06-03 8:50 ` Jean-Christophe Helary
2017-06-03 9:59 ` Eli Zaretskii
2017-06-03 13:50 ` Jean-Christophe Helary
2017-06-03 14:46 ` Eli Zaretskii
2017-06-03 23:45 ` Jean-Christophe Helary
2017-06-04 2:38 ` Eli Zaretskii
2017-06-04 7:49 ` Michael Albinus
2017-06-04 9:19 ` Jean-Christophe Helary
2017-06-04 13:57 ` Eli Zaretskii
2017-06-04 15:14 ` Jean-Christophe Helary
2017-06-04 15:46 ` Eli Zaretskii
2017-06-05 0:33 ` Jean-Christophe Helary
2017-06-05 2:46 ` Eli Zaretskii
2017-06-05 3:31 ` Jean-Christophe Helary
2017-06-05 5:15 ` Jean-Christophe Helary
2017-06-05 15:09 ` Eli Zaretskii
2017-06-05 21:24 ` Jean-Christophe Helary
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=83o9up2hli.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=26925-done@debbugs.gnu.org \
--cc=jean.christophe.helary@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).