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

Previous Next

Full log

Message #16 received at 34274-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Nicholas Drozd <nicholasdrozd <at> gmail.com>
Cc: 34274-done <at> debbugs.gnu.org
Subject: Re: bug#34274: [PATCH] * src/callproc.c (call-process/region): Fix
 docstring arg formatting
Date: Fri, 08 Feb 2019 10:47:30 +0200

> From: Nicholas Drozd <nicholasdrozd <at> gmail.com>
> Date: Mon, 4 Feb 2019 17:55:51 -0600
> Cc: 34274 <at> debbugs.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.

Thanks, I fixed these doc strings in the spirit of your suggestions.

Previous Next

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