groff-commit
[Top][All Lists]
Advanced

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

[groff] 27/35: [docs]: Fix style nits.


From: G. Branden Robinson
Subject: [groff] 27/35: [docs]: Fix style nits.
Date: Mon, 21 Feb 2022 06:15:59 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 0e661dca20f5d906d9e3c90a2031b1657f5df87f
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Feb 21 04:10:01 2022 +1100

    [docs]: Fix style nits.
    
    * Migrate terminology: "escape" -> "escape sequence".
    * Tighten wording.
    * Sync groff_diff(7) with our Texinfo manual.
---
 doc/groff.texi       | 15 +++++++--------
 man/groff_diff.7.man | 13 +++++++------
 2 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 5816e6a9..ce5b5adc 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -7740,11 +7740,10 @@ just prior to it; most likely this isn't what you want.
 @cindex breaking file names (@code{\:})
 @cindex URLs, breaking (@code{\:})
 @cindex breaking URLs (@code{\:})
-The @code{\:} escape inserts a non-printing break point; that is, the
-word can break there, but the soft hyphen glyph (see below) is not
-written to the output if it does.  This escape is an input word
-boundary, so the remainder of the word is subject to hyphenation as
-normal.
+@code{\:} inserts a non-printing break point; that is, a word can break
+there, but the soft hyphen glyph (see below) is not written to the
+output if it does.  This escape sequence is an input word boundary, so
+the remainder of the word is subject to hyphenation as normal.
 
 You can use @code{\:} and @code{\%} in combination to control breaking
 of a file name or URL or to permit hyphenation only after certain
@@ -10948,7 +10947,7 @@ help with this.
 Apply an @dfn{italic correction}:@: modify the spacing of the preceding
 glyph so that the distance between it and the following glyph is correct
 if the latter is of upright shape.  For example, if an
-italic@tie{}@samp{f} is immediately followed by a roman right
+italic@tie{}@samp{f} is followed immediately by a roman right
 parenthesis, then in many fonts the top right portion of
 the@tie{}@samp{f} overlaps the top left of the right parenthesis, which
 is ugly.  Use this escape sequence whenever an oblique glyph is
@@ -11972,8 +11971,8 @@ an error.  @xref{Writing Macros}.
 @cindex string, removing alias for (@code{rm})
 @cindex macro, removing alias for (@code{rm})
 @cindex diversion, removing alias for (@code{rm})
-To remove an alias, simply call @code{rm} on its name.  The object
-itself is not destroyed until it has no more names.
+To remove an alias, call @code{rm} on its name.  The object itself is
+not destroyed until it has no more names.
 @endDefreq
 
 
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 5a082eab..d8376ee2 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -843,7 +843,7 @@ modify the spacing of the preceding glyph so that the 
distance between
 it and the following glyph is correct if the latter is of upright shape.
 .
 For example,
-if an italic\~\[lq]f\[rq] is immediately followed by a roman right
+if an italic\~\[lq]f\[rq] is followed immediately by a roman right
 parenthesis,
 then in many fonts the top right portion of the\~\[lq]f\[rq] overlaps
 the top left of the right parenthesis,
@@ -900,12 +900,12 @@ immediately by an oblique glyph without any intervening 
space.
 Insert a non-printing break point.
 .
 That is,
-the word can break there,
+a word can break there,
 but the soft hyphen glyph is not written to the output if it does
 (in contrast to
 .RB \[lq] \[rs]% \[rq]).
 .
-This escape is an input word boundary,
+This escape sequence is an input word boundary,
 so the remainder of the word is subject to hyphenation as normal.
 .
 .
@@ -1057,7 +1057,8 @@ If
 is undefined,
 a warning of type
 .RB \[lq] mac \[rq]
-is generated and the request is ignored.
+is produced,
+and the request is ignored.
 .
 The
 .BR .am ,
@@ -1069,7 +1070,7 @@ and
 .B .ds
 requests
 (together with their variants)
-only create a new object if the name of the macro,
+create a new object only if the name of the macro,
 diversion,
 or string is currently undefined
 or if it is defined as a request;
@@ -1077,7 +1078,7 @@ normally,
 they modify the value of an existing object.
 .
 To remove an alias,
-simply call
+call
 .B .rm
 on its name.
 .



reply via email to

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