GNU bug report logs - #23623
Patch to improve function options in find-func.el

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: rswgnu <at> gmail.com
Cc: 23623 <at> debbugs.gnu.org, npostavs <at> users.sourceforge.net
Subject: bug#23623: Patch to improve function options in find-func.el
Date: Mon, 18 Dec 2017 18:49:56 +0200

> From: Robert Weiner <rsw <at> gnu.org>
> Date: Mon, 18 Dec 2017 11:24:44 -0500
> Cc: Noam Postavsky <npostavs <at> users.sourceforge.net>, 23623 <at> debbugs.gnu.org
> 
> I often find
> that I have to make the first line of docstrings long
> when it involves 3 or more arguments.  Is it preferable
> in such cases where the text cannot be shortened enough
> to discuss only some of the arguments on the first line
> and document the rest afterwards?

If there's no other way, yes.

A better alternative is to mention all the arguments, but refrain from
describing the function's effect in full, leaving the detailed
description to the rest of the doc string.  IOW, say only the main
part in the first sentence.

Previous Next

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