GNU bug report logs - #34274
[PATCH] * src/callproc.c (call-process/region): Fix docstring arg formatting

Previous Next

Package: emacs;

Reported by: Nicholas Drozd <nicholasdrozd <at> gmail.com>

Date: Fri, 1 Feb 2019 14:15:01 UTC

Severity: normal

Tags: patch

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Nicholas Drozd <nicholasdrozd <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 34274 <at> 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

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.
This bug report was last modified 6 years and 183 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.