From: Alejandro Colomar <alx.manpages@gmail.com>
To: "G . Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Alejandro Colomar <alx.manpages@gmail.com>,
mtk.manpages@gmail.com, linux-man@vger.kernel.org
Subject: [RFC] man-pages.7: Add phrasal semantic newlines advise
Date: Fri, 12 Nov 2021 23:54:23 +0100 [thread overview]
Message-ID: <20211112225423.8361-1-alx.manpages@gmail.com> (raw)
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
man7/man-pages.7 | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 23015b00a..b52a2260a 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -640,11 +640,13 @@ makes it easier to write tools that parse man page source files.)
.SS Use semantic newlines
In the source of a manual page,
new sentences should be started on new lines,
-and long sentences should be split into lines at clause breaks
-(commas, semicolons, colons, and so on).
+long sentences should be split into lines at clause breaks
+(commas, semicolons, colons, and so on),
+and long clauses should be split at phrase boundaries.
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.
.\"
.SS Formatting conventions (general)
Paragraphs should be separated by suitable markers (usually either
--
2.33.1
next reply other threads:[~2021-11-12 22:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-12 22:54 Alejandro Colomar [this message]
2021-11-13 0:06 ` [RFCv2] man-pages.7: Add phrasal semantic newlines advise Alejandro Colomar
2021-11-22 7:37 ` G. Branden Robinson
2021-11-22 11:59 ` 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=20211112225423.8361-1-alx.manpages@gmail.com \
--to=alx.manpages@gmail.com \
--cc=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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox