util-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Adam Sampson <ats@offog.org>
To: Benno Schulenberg <bensberg@justemail.net>
Cc: util-linux@vger.kernel.org
Subject: Re: RFC [patch] adding docstrings
Date: Thu, 18 Dec 2014 09:20:26 +0000	[thread overview]
Message-ID: <y2ah9wtwbz9.fsf@cartman.at.offog.org> (raw)
In-Reply-To: <1418847631-8317-1-git-send-email-bensberg@justemail.net> (Benno Schulenberg's message of "Wed, 17 Dec 2014 21:20:31 +0100")

Benno Schulenberg <bensberg@justemail.net> writes:

> This patch adds a docstring (a one-line description) to each of the
> utilities.

Is it worth synchronising these descriptions with the one-liners in the
"NAME" sections of the man pages (i.e. what apropos shows)? I think the
one you've come up with for addpart is clearer than the existing one in
the man page, for example...

-- 
Adam Sampson <ats@offog.org>                         <http://offog.org/>

  reply	other threads:[~2014-12-18  9:48 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-17 20:20 RFC [patch] adding docstrings Benno Schulenberg
2014-12-18  9:20 ` Adam Sampson [this message]
2014-12-18 20:29   ` Benno Schulenberg
2014-12-19  9:09 ` Karel Zak
2014-12-20 14:42   ` Benno Schulenberg
2014-12-22 10:11     ` Karel Zak

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=y2ah9wtwbz9.fsf@cartman.at.offog.org \
    --to=ats@offog.org \
    --cc=bensberg@justemail.net \
    --cc=util-linux@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).