groff-commit
[Top][All Lists]
Advanced

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

[groff] 07/11: groff_man*(7): Fix style nits.


From: G. Branden Robinson
Subject: [groff] 07/11: groff_man*(7): Fix style nits.
Date: Sat, 31 Jul 2021 10:36:29 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit c146549c1ccd506057b57dd8b9dffbea9a7596cd
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Jul 31 15:54:41 2021 +1000

    groff_man*(7): Fix style nits.
    
    * Break input line after comma.
    * Consistently use term "escape sequence[s]", even in comments.
    * Use \~ escape sequence instead of \SP.
    * (Options) Tighten wording.
    * Be more careful with ellipses.
      - Use thin space escape sequence between last dot in an ellipsis and a
        subsequent comma.
      - Stop using pointless non-printing input break escape sequence after
        an ellipsis that is not followed by a sentence-ending punctuation.
      - Fix typo in attempted thin space escape sequence.
    * Put periods at end of "problem" sentences in troubleshooting section.
---
 tmac/groff_man.7.man.in | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 6cd61e5..6e10dab 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -2197,7 +2197,8 @@ document maintenance.
 Control hyphenation.
 .
 The location of this escape sequence within a word marks a hyphenation
-point, supplementing
+point,
+supplementing
 .IR groff 's
 automatic hyphenation patterns.
 .
@@ -2454,8 +2455,8 @@ or
 .B .RI
 macros,
 you will need to manually add an italic correction escape sequence
-.\" Normally we don't quote escapes, but these use potentially-confusing
-.\" prose punctuation.
+.\" Normally, we don't quote escape sequences, but these use potentially
+.\" confusing prose punctuation.
 .RB \(lq \e/ \(rq,
 a GNU extension,
 before the
@@ -2516,7 +2517,7 @@ and it is slightly more portable than the more explicit
 .
 .
 .TP
-.BR \efB ,\  \efI ,\  \efR ,\  \efP
+.BR \efB ,\~ \efI ,\~ \efR ,\~ \efP
 Switch to bold,
 italic,
 roman,
@@ -2888,13 +2889,11 @@ SunOS\~4.0 (1988) may have been the first to support
 The following
 .I groff
 options set registers
-(with the
-.B \-r
-option)
+(with
+.BR \-r )
 and strings
-(with the
-.B \-d
-option)
+(with
+.BR \-d )
 recognized and used by the
 .I man
 macro package.
@@ -3112,7 +3111,7 @@ default.
 .TP
 .BI \-rX p
 After
-.RI page " p" ,
+.RI page\~ p ,
 number pages as
 .IR p a,
 .IR p b,
@@ -3132,7 +3131,7 @@ numbers: 1,
 2,
 2a,
 2b,
-\&.\|.\|.\&,
+\&.\|.\|.\|,
 2aa,
 2ab,
 and so on.
@@ -3306,7 +3305,7 @@ often a shorter or clearer alternative is available.
 .TS
 c c
 lfCB lfCB.
-Instead of.\|.\.       .\|.\|.do this.
+Instead of.\|.\|.      .\|.\|.do this.
 _
 \&.TP \(dq\(dq .TP
 \&.BI \(dq\(dq italic-text bold-text   .IB italic-text bold-text
@@ -3343,7 +3342,7 @@ which can be overlooked in source and rendered forms.
 .
 .
 .TP
-.RB \(bu " .RS" " doesn't indent relative to my indented paragraph"
+.RB \(bu " .RS" " doesn't indent relative to my indented paragraph."
 The
 .B .RS
 macro sets the left margin;
@@ -3378,7 +3377,7 @@ values.
 .
 .
 .TP
-.RB \(bu " .RE" " doesn't move the inset back to the expected level"
+.RB \(bu " .RE" " doesn't move the inset back to the expected level."
 .TQ
 \(bu warning: scaling indicator invalid in this context
 .TQ



reply via email to

[Prev in Thread] Current Thread [Next in Thread]