From: Eli Zaretskii <eliz@gnu.org>
To: rswgnu@gmail.com
Cc: npostavs@users.sourceforge.net, 23623@debbugs.gnu.org
Subject: bug#23623: Patch to improve function options in find-func.el
Date: Mon, 18 Dec 2017 18:49:56 +0200 [thread overview]
Message-ID: <83po7coua3.fsf@gnu.org> (raw)
In-Reply-To: <CA+OMD9i+F-A_4YfG3csqFegLhx6L02WWKoRb8W+F7nBEGBa=VQ@mail.gmail.com> (message from Robert Weiner on Mon, 18 Dec 2017 11:24:44 -0500)
> From: Robert Weiner <rsw@gnu.org>
> Date: Mon, 18 Dec 2017 11:24:44 -0500
> Cc: Noam Postavsky <npostavs@users.sourceforge.net>, 23623@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.
next prev parent reply other threads:[~2017-12-18 16:49 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-26 15:52 Patch to improve function options in find-func.el Robert Weiner
2017-11-07 1:03 ` bug#23623: " Noam Postavsky
2017-12-18 4:33 ` Robert Weiner
2017-12-18 16:07 ` Eli Zaretskii
2017-12-18 16:24 ` Robert Weiner
2017-12-18 16:49 ` Eli Zaretskii [this message]
2019-11-08 4:16 ` Stefan Kangas
2020-08-11 15:25 ` Lars Ingebrigtsen
2020-08-11 15:36 ` Lars Ingebrigtsen
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83po7coua3.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=23623@debbugs.gnu.org \
--cc=npostavs@users.sourceforge.net \
--cc=rswgnu@gmail.com \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).