[Top][All Lists]

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

[groff] 60/72: doc/ Clarify several points.

From: G. Branden Robinson
Subject: [groff] 60/72: doc/ Clarify several points.
Date: Sun, 23 Oct 2022 22:25:45 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 51b155c24c6d3810973d101b726a3d99b66a49da
Author: G. Branden Robinson <>
AuthorDate: Sun Oct 23 15:34:25 2022 -0500

    doc/ Clarify several points.
    - User identifiers must contain at least one uppercase letter.  This
      avoids collisions with eqn's '10' string and some punctuation-only
      identifiers used internally by me(7).
    - Describe "vertical spacing" as "text baseline spacing"; "spacing"
      suggests a repeated process better than "distance" does.
    - Characterize the tag T argument to `ip` as optional.  This was already
      implied, but it seems important to assure the reader that (tagless)
      indented paragraphs are easily obtained.
    - Tighten wording.
    - Explicitly identify default values of \n(bs and \n(qs instead of by
      reference to \n(ps, so that the reader doesn't infer that aliasing is
      ocurring, and that `bs` and `qs` will change if `ps` is altered.
 doc/ | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

diff --git a/doc/ b/doc/
index b12d8bdb0..a9e88a054 100644
--- a/doc/
+++ b/doc/
@@ -214,8 +214,8 @@ any user-defined register,
 or macro
 names should be single numerals or uppercase letters,
-or any longer sequence of numerals and/or
-letters as long as at least one letter is uppercase.\**
+or any longer character sequence
+including at least one uppercase letter.\**
 For portability between BSD and \*G \*(ME,
@@ -244,7 +244,7 @@ to
 .NR (pp
 and vertical spacing
-(text baseline distance)
+(text baseline spacing)
 .NR (tv
@@ -287,7 +287,7 @@ to the first output line.
 .b .lp ,
 but set the paragraph
-with a hanging tag
+with an optional hanging tag
 .i T
 and the remainder indented by
@@ -306,10 +306,11 @@ Any spaces in
 must be unbreakable.
 .i T
-will not fit in the space
+does not fit in the space
 .i i,
 .b .ip
-puts the text after the tag on a new line.
+breaks the line after
+.i T .
 .b .np
@@ -698,8 +699,7 @@ and long quotations
 are preceded and followed
 by an extra
 .NR (bs
-[same as
-.NR (ps ]
 of vertical space
 and use a vertical spacing of
 .NR (dv
@@ -766,8 +766,7 @@ by
 preceded and followed
 .NR (qs
-[same as
-.NR (bs ]
 and set at type size
 .NR (qp

reply via email to

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