[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug #51328] [man pages] prevent unintended inter-sentence space
From: |
G. Branden Robinson |
Subject: |
[bug #51328] [man pages] prevent unintended inter-sentence space |
Date: |
Fri, 17 Jun 2022 00:51:08 -0400 (EDT) |
Update of bug #51328 (project groff):
Item Group: Documentation => Lint
Status: Need Info => Fixed
Open/Closed: Open => Closed
Planned Release: None => 1.23.0
Summary: [PATCH] [man pages] prevent unintended
inter-sentence space => [man pages] prevent unintended inter-sentence space
_______________________________________________________
Follow-up Comment #4:
I've fixed this independently with a variety of commits over the past few
years. Here's a sample.
commit fd04c52f8093fd3fadf1bee54d4016bf89244b5a
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Wed Jun 15 06:04:56 2022 -0500
chem(1): Fix markup nits.
Use idiomatic input style, placing newlines after sentences and commas.
Also put an empty request between sentences.
commit c66e7ce030ce764cb02a0267a49e147e15adebfd
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Wed Jun 15 01:41:09 2022 -0500
[man pages]: Fix markup nit.
Add `\&` after a dot followed by multiple spaces in displayed examples,
to keep the rendering consistent even if the reader changes the
supplemental inter-sentence space amount.
commit 2d8c81931640e263653a4ff3b377cabfdb530ce9
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Thu Mar 31 06:45:53 2022 +1100
roff(7): Fix style and markup nits.
* Add `\&` after sentence-ending candidate punctuation when discussing
this very feature.
* Wrap long input line.
commit 79afd29a346f97c687fadb1878e66471803955b3
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Sun Oct 31 21:07:06 2021 +1100
tbl(1): Do some spot cleaning.
Content:
* Start standardizing the term "(table) region" as that material between
".TS" and the first subsequent ".TE".
* Start standardizing the term "(table) description". (A table region
consists of one (or more, separated by .T&) table description(s)).
* Add parenthetical paragraph aiding the reader who knows just enough
*roff to start making unwarranted assumptions (as I once did, and
probably will continue to do). Try to clarify the fact that ".TS",
".T&", ".TE" are input tokens to tbl, but macro calls to troff.
* When introducing the term "decimal separator", note that it is
configurable, in hopes of justifying the sesquipedalian terminology.
* Speak of "alignment", not "justification".
* Advise when tbl(1) generates *roff code to produce warning messages.
(There are other cases not yet noted.)
* Prefer "table entries" to "data items".
* Instead of talking about "whitespace", identify specific input
characters.
* Remove discussion of "column separator lines" (not allowing '_', '-',
or '='); I couldn't figure out what was meant.
Style:
* Recast to use more formal and idiomatic English.
* Stop ending sentences with colons.
* Speak consistently of "GNU extensions", not "GNU tbl only". Other
implementations might adopt GNU extensions.
* Say "AT&T", not "Unix", tbl. There are many Unices and not all
shipped AT&T troff (or not exclusively).
* Use "\[em]", not " \[en] ", to "break" (interrupt) a sentence.
* Turn some sentence fragments into parentheticals.
* Add space after commas in table format specifiers used as paragraph
tags.
Markup:
* Break input lines after commas.
* Break input lines before and after multi-word parentheticals.
* Use two empty requests where vertical space is expected.
* Protect non-sentential dots from end-of-sentence detection.
commit aceac1232e2ed33d87b4fbd8fbba319d4d48681d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Sun Nov 8 11:09:58 2020 +1100
refer(1): Avoid inter-sentence spacing after dot.
Also see:
commit c33c23a10b314393d43fd4d41306729b36ba92fa
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Tue Jun 14 19:39:00 2022 -0500
doc/webpage.ms: Fix markup nit.
Use `\&` after '.' and multiple spaces in unfilled example of groff
source. It is a better stylistic practice since additional
inter-sentence space is applied even when filling is disabled.
commit cb1b89620ff5b0b509831a3b8ecf4f1916d34567
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date: Thu Dec 16 08:20:58 2021 +1100
doc/meref.me.in: Fix feature summary table nits.
...observed while revising groff_me(7).
* Remove junk comment line (I de-documented \SP in favor of \~).
* Add non-printing input break `\&` between non-sentence ending period
and space.
* Be more consistent: we say "(pre/post) space", not "spacing" when
referring to registers containing vertical distances to be inserted by
the package adjacent to various constructs. I try to reserve the term
"spacing" for baseline separation (registers `$V` and `$v`).
* Recast descriptions of `lp` and `pp` to distinguish them better.
_______________________________________________________
Reply to this item at:
<https://savannah.gnu.org/bugs/?51328>
_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/