Re: [PATCH v2] Various pages: tfix

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxx>

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: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux