All of lore.kernel.org
 help / color / mirror / Atom feed
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: mtk.manpages@gmail.com, linux-man@vger.kernel.org
Subject: Re: [PATCH v2] Various pages: tfix
Date: Fri, 25 Dec 2020 10:38:01 +1100	[thread overview]
Message-ID: <20201224233759.kvrdgyhtxivl2m43@localhost.localdomain> (raw)
In-Reply-To: <20201223191705.13141-1-alx.manpages@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1129 bytes --]

At 2020-12-23T20:17:06+0100, Alejandro Colomar wrote:
> Remove "." at the end of sentence fragments/short single sentences
> in comments.  See: c2e81ff9641a7743b1f47cbf4fcf899c391df77f.
> 
> $ sed -i '/[^.]\. \*\//s%\. \*/% */%' man?/*
> 
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

I'd like to cast my feeble vote against this proposed change; from
reading the diff, it seems mostly to remove punctuation from the ends of
things that _are_ complete sentences, and not fragments.  Some of these
(like readlink(2) @ 338) are part of multi-sentence comments, and having
sentence-ending punctuation in all but the last sentence of such things
looks inconsistent to me.

In general I think complete sentences should be used in code comments,
and normative English grammar used for those sentences, with a deviation
for short noun phrases documenting variable declarations--although often
one is better advised to take the advice of Kernighan/Pike and others,
and use a communicative variable name in such cases.

Two cents from a Tiny Tim on Christmas Day.  ;-)

Happy holidays!

--Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2020-12-24 23:39 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-23 19:02 [PATCH] Various pages: tfix Alejandro Colomar
2020-12-23 19:17 ` [PATCH v2] " Alejandro Colomar
2020-12-24 23:38   ` G. Branden Robinson [this message]
2020-12-27 11:54 ` [PATCH] " Michael Kerrisk (man-pages)
2020-12-28  9:20   ` Alejandro Colomar (man-pages)
2020-12-28  9:31     ` Alejandro Colomar (man-pages)

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=20201224233759.kvrdgyhtxivl2m43@localhost.localdomain \
    --to=g.branden.robinson@gmail.com \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.