From: Nicholas Drozd <nicholasdrozd@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 34274@debbugs.gnu.org
Subject: bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting
Date: Mon, 4 Feb 2019 17:55:51 -0600 [thread overview]
Message-ID: <CABAiW0r6pcWoEHTba8p96c1G1e3eCT3jz5AxFacD3TrQ2vLMYg@mail.gmail.com> (raw)
In-Reply-To: <83bm3vy207.fsf@gnu.org>
The usual docstring convention is to put arg names in CAPS, making it
easier to find mentions of the arguments, especially by text search.
Right now if you search the docstring of call-process for ARGS, you
won't find anything. There's "remaining arguments", but it's up to the
reader to figure out that that refers to ARGS. This change just makes
it easier to navigate.
In the second case I also changed "command args" to "command
arguments". This change is unimportant; I just thought it looks nicer.
next prev parent reply other threads:[~2019-02-04 23:55 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-01 14:13 bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting Nicholas Drozd
2019-02-01 15:14 ` Eli Zaretskii
2019-02-04 23:55 ` Nicholas Drozd [this message]
2019-02-08 8:47 ` Eli Zaretskii
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=CABAiW0r6pcWoEHTba8p96c1G1e3eCT3jz5AxFacD3TrQ2vLMYg@mail.gmail.com \
--to=nicholasdrozd@gmail.com \
--cc=34274@debbugs.gnu.org \
--cc=eliz@gnu.org \
/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.