GNU bug report logs - #35163
25.1; `narrow-to-region' docstring no mention of args

Previous Next

Full log

View this message in rfc822 format

From: Noam Postavsky <npostavs <at> gmail.com>
To: 35163 <at> debbugs.gnu.org
Cc: , Emanuel Berg <moasenwood <at> zoho.eu>
Subject: bug#35163: 25.1; `narrow-to-region' docstring no mention of args
Date: Mon, 08 Apr 2019 19:09:39 -0400

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

>> From: Glenn Morris <rgm <at> gnu.org>

>> OP wants every doc string to literally contain the upper-case argument
>> names, ie START and END in this case (as per eg checkdoc's "Argument ...
>> should appear (as ...) in the doc string"). If you agree, it's a trivial
>> change. If not, close as wontfix.
>
> Thanks, fixed.
>
>> (People who have particular ideas about doc strings could save everyone
>> a lot of time by sending patches.)
>
> Or at least a clear description of the problem.

To be fair, message [11] is fairly clear and pretty close to what Glenn
wrote (perhaps it misses the emphasis on satisfying checkdoc).  Things
unfortunately derailed after that.

An 80+ line elisp riddle on a report about a docstring bug is surely a
sign something has gone horribly wrong...

[11]: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=35163#11

Previous Next

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