[prev in list] [next in list] [prev in thread] [next in thread] 

List:       linux-man
Subject:    Re: [RFCv2] man-pages.7: Add phrasal semantic newlines advise
From:       "Alejandro Colomar (man-pages)" <alx.manpages () gmail ! com>
Date:       2021-11-22 11:59:54
Message-ID: 1702be66-028c-47af-4015-2ea42b3e519a () gmail ! com
[Download RAW message or body]

Hi, Branden!

On 11/22/21 08:37, G. Branden Robinson wrote:
>> The downside is that they are more difficult to automatically spot
>> than clause breaks (which tend to have associated punctuation).
>> But we are humans writing patches,
>> not machines,
>> and therefore we should be able to decide and detect them better.
> 
> I, do, however, find the free verse style more difficult to read in
> email, as a rule.  A brain is a modal thing, and when I'm reading emails
> I'm generally prepared for prose.  When I'm editing a man page, my mind
> is in a different mode, and better prepared for the foregoing textual
> style.

Sorry :)

>>   This convention, sometimes known as "semantic newlines",
>>   makes it easier to see the effect of patches,
>> -which often operate at the level of individual sentences or sentence clauses.
>> +which often operate at the level of
>> +individual sentences, sentence clauses, or phrases.
> 
> I would drop the qualifier "sentence" from "sentence clause(s)" here.
> One wonders, "what's a NON-sentence clause"?  Just "clauses" is fine. >
> This noun is not otherwise used in the man-pages project except very
> rarely to refer to items in legal notices, another standard usage with a
> clearly distinct context.  In the context of the patch, the discussion
> is obviously grammatical and sentential.

Makes sense; will do.

> 
> Apart from that, LGTM!
> 
> Regards,
> Branden
> 


Thanks!
Alex


-- 
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
[prev in list] [next in list] [prev in thread] [next in thread]