groff-commit
[Top][All Lists]
Advanced

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

[groff] 08/09: [docs]: Fix style nits.


From: G. Branden Robinson
Subject: [groff] 08/09: [docs]: Fix style nits.
Date: Mon, 22 May 2023 02:43:26 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 76ace3d5d91c183a47af14cea4d0a8f74fecfab3
Author: Dave Kemper <saint.snit@gmail.com>
AuthorDate: Mon May 22 03:40:50 2023 +0000

    [docs]: Fix style nits.
    
    [docs]: Correct minor punctuation, grammar, and spelling issues.
    
    Also remove a couple instances of unnecessarily telling the reader to
    note something.
    
    * doc/groff.texi:
    * man/groff.7.man:
    * man/groff_char.7.man:
    * man/groff_diff.7.man:
    * man/roff.7.man:
    * src/roff/nroff/nroff.1.man: Do it.
    
    [I threw in a few more fixes.  --GBR]
    
    Fixes <https://savannah.gnu.org/bugs/?64230>.
---
 ChangeLog                  | 17 ++++++++++++++++
 doc/groff.texi             | 49 +++++++++++++++++++++++-----------------------
 doc/ms.ms                  |  2 +-
 man/groff.7.man            |  4 ++--
 man/groff_char.7.man       |  2 +-
 man/groff_diff.7.man       |  2 +-
 man/roff.7.man             | 12 ++++++------
 src/roff/nroff/nroff.1.man |  2 +-
 tmac/fallbacks.tmac        |  2 +-
 9 files changed, 54 insertions(+), 38 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 99ba97e00..13f1e1d59 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,20 @@
+2023-05-22  Dave Kemper <saint.snit@gmail.com>
+
+       [docs]: Correct minor punctuation, grammar, and spelling issues.
+
+       Also remove a couple instances of unnecessarily telling the
+       reader to note something.
+
+       * doc/groff.texi:
+       * man/groff.7.man:
+       * man/groff_char.7.man:
+       * man/groff_diff.7.man:
+       * man/roff.7.man:
+       * src/roff/nroff/nroff.1.man: Do it.
+
+       Fixes <https://savannah.gnu.org/bugs/?64230>.  [I threw in a few
+       more fixes.  --GBR]
+
 2023-04-22  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        [docs]: Attempt to further clarify end-of-sentence detection.
diff --git a/doc/groff.texi b/doc/groff.texi
index b6c20f6c4..bf88cb8ff 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -908,9 +908,9 @@ built).  It can optionally preprocess with any of 
@code{gpic},
 @code{geqn}, @code{gtbl}, @code{ggrn}, @code{grap}, @code{gchem},
 @code{grefer}, @code{gsoelim}, or @code{preconv}.
 
-This section only documents options to the @code{groff} front end.  Many
-of the arguments to @code{groff} are passed on to @code{gtroff},
-therefore those are also included.  Arguments to preprocessors and
+This section documents only options to the @code{groff} front end.  Many
+of the arguments to @code{groff} are passed on to @code{gtroff};
+therefore, those are also included.  Arguments to preprocessors and
 output drivers can be found in the man pages @cite{gpic@r{(1)}},
 @cite{geqn@r{(1)}}, @cite{gtbl@r{(1)}}, @cite{ggrn@r{(1)}},
 @cite{grefer@r{(1)}}, @cite{gchem@r{(1)}}, @cite{gsoelim@r{(1)}},
@@ -2165,7 +2165,7 @@ groff -m man -m ms foo.man bar.doc
 @cindex auxiliary macro package
 @cindex package, macro, auxiliary
 @cindex macro package, auxiliary
-Many auxiliary, or ``minor'' macro packages are also available.  They
+Many auxiliary, or ``minor'', macro packages are also available.  They
 may in general be used with any full-service macro package and handle a
 variety of tasks from character encoding selection, to language
 localization, to inlining of raster images.  See the
@@ -2506,7 +2506,7 @@ don't.
 
 After that, start typing normally.  It is a good practice to start each
 sentence on a new line, or to put two spaces after sentence-ending
-puncutation, so that the formatter knows where the sentence boundaries
+punctuation, so that the formatter knows where the sentence boundaries
 are.  You can separate paragraphs with further paragraphing macros, or
 with blank lines, and you can indent with tabs.  When you need one of
 the features mentioned earlier (@pxref{ms}), return to this part of the
@@ -5043,7 +5043,7 @@ Barnum.
 ``Barnum'' doesn't begin a sentence!  What to do?  Let us meet our first
 @dfn{escape sequence}, a series of input characters that give
 instructions to GNU @code{troff} instead of being used to construct
-output device glyphs.@footnote{This statement oversimplifes; there are
+output device glyphs.@footnote{This statement oversimplifies; there are
 escape sequences whose purpose is precisely to produce glyphs on the
 output device, and input characters that @emph{aren't} part of escape
 sequences can undergo a great deal of processing before getting to the
@@ -5348,7 +5348,7 @@ Heywood Jabuzzoff
 
 In fact, the ending marker is itself the name of a macro to be
 called, or a request to be invoked, if it is defined at the time its
-contol line is read.
+control line is read.
 
 @Example
 .de END
@@ -5736,7 +5736,7 @@ scripts.}  The @dfn{text baseline} is a (usually 
invisible) line upon
 which the glyphs of a typeface are aligned.  A glyph therefore
 ``starts'' at its bottom-left corner.  If drawn at the origin, a typical
 letter glyph would lie partially or wholly off the page, depending on
-whether, like ``g'', it features a decender below the baseline.
+whether, like ``g'', it features a descender below the baseline.
 
 @cindex page offset
 @cindex offset, page
@@ -6991,7 +6991,7 @@ has been saved.
 Use these requests together to temporarily change the escape character.
 @endDefreq
 
-Using a different escape character, or disbling it, when calling macros
+Using a different escape character, or disabling it, when calling macros
 not under your control will likely cause errors, since GNU @code{troff}
 has no mechanism to ``intern'' macros---that is, to convert a macro
 definition into a form independent of its
@@ -7473,10 +7473,10 @@ Register contents are interpolated with the @code{\n} 
escape sequence.
 Interpolate register with name @var{ident} (one-character
 name@tie{}@var{i}, two-character name @var{id}).  @code{\n} is
 interpreted even in copy mode (@pxref{Copy Mode}).  If the register is
-undefined, it is created, assigned a value of@tie{}@samp{0}, that value
-is interpolated, and a warning in category @samp{reg} is emitted.
-@xref{Warnings}, for information about the enablement and suppression
-of warnings.
+undefined, it is created and assigned a value of@tie{}@samp{0}, that
+value is interpolated, and a warning in category @samp{reg} is emitted.
+@xref{Warnings}, for information about the enablement and suppression of
+warnings.
 
 @Example
 .nr a 5
@@ -10771,10 +10771,10 @@ Examples:
 @table @code
 @item \[A ho]
 @samp{A} maps to @code{u0041}, @samp{ho} maps to @code{u02DB}, thus the
-final glyph name would be @code{u0041_02DB}.  Note this is not the
-expected result: The ogonek glyph @samp{ho} is a spacing ogonek, but for
-a proper composite a non-spacing ogonek (U+0328) is necessary.  Looking
-into the file @file{composite.tmac} one can find @w{@samp{.composite ho
+final glyph name would be @code{u0041_02DB}.  This is not the expected
+result:@: the ogonek glyph @samp{ho} is a spacing ogonek, but for a
+proper composite a non-spacing ogonek (U+0328) is necessary.  Looking
+into the file @file{composite.tmac}, one can find @w{@samp{.composite ho
 u0328}}, which changes the mapping of @samp{ho} while a composite glyph
 name is constructed, causing the final glyph name to be
 @code{u0041_0328}.
@@ -10967,8 +10967,8 @@ numeric ranges like ``3000--5000'', insert
 @endExample
 
 @noindent
-into your document.  Note, however, that this can lead to bad layout if
-done without thinking; in most situations, a better solution instead of
+into your document.  However, this practice can lead to bad layout if
+done thoughtlessly; in most situations, a better solution instead of
 changing the @code{cflags} value is to insert @code{\:} right after the
 hyphen at the places that really need a break point.
 @end table
@@ -16461,11 +16461,10 @@ the @code{unformat} request.
 Macros only contain elements in the token list (and the node list is
 empty); diversions and strings can contain elements in both lists.
 
-Note that the @code{chop} request simply reduces the number of elements
-in a macro, string, or diversion by one.  Exceptions are
-@dfn{compatibility save} and @dfn{compatibility ignore} input tokens,
-which are ignored.  The @code{substring} request also ignores those
-input tokens.
+The @code{chop} request simply reduces the number of elements in a
+macro, string, or diversion by one.  Exceptions are @dfn{compatibility
+save} and @dfn{compatibility ignore} input tokens, which are ignored.
+The @code{substring} request also ignores those input tokens.
 
 Some requests like @code{tr} or @code{cflags} work on glyph identifiers
 only; this means that the associated glyph can be changed without
@@ -18724,7 +18723,7 @@ The @var{code} field gives a numeric identifier that 
the postprocessor
 uses to render the glyph.  The glyph can be specified to @code{troff}
 using this code by means of the @code{\N} escape sequence.  @var{code}
 can be any integer.@footnote{that is, any integer parsable by the C
-standard library's @code{strotol} function}
+standard library's @code{strtol} function}
 
 The @var{entity-name} field defines an identifier for the glyph that the
 postprocessor uses to print the GNU @code{troff} glyph @var{name}.  This
diff --git a/doc/ms.ms b/doc/ms.ms
index c8ec38411..a74310c54 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -177,7 +177,7 @@ After that,
 start typing normally.
 .
 It is a good practice to start each sentence on a new line,
-or to put two spaces after sentence-ending puncutation,
+or to put two spaces after sentence-ending punctuation,
 so that the formatter knows where the sentence boundaries are.
 .
 You can separate paragraphs with further paragraphing macro calls,
diff --git a/man/groff.7.man b/man/groff.7.man
index 2b4daf907..bb2d5c7d2 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -2270,7 +2270,7 @@ but their interpolated contents can be.
 .
 .TPx
 .I N
-is an optionally-signed numeric expression.
+is an optionally signed numeric expression.
 .
 .TPx
 .I \[+-]N
@@ -4517,7 +4517,7 @@ as arguments.
 .
 .TP
 .ESC $0
-Interpolate name by which currently-executing macro was invoked.
+Interpolate name by which currently executing macro was invoked.
 .
 .
 .TP
diff --git a/man/groff_char.7.man b/man/groff_char.7.man
index 14aeeaaee..86f613b25 100644
--- a/man/groff_char.7.man
+++ b/man/groff_char.7.man
@@ -1277,7 +1277,7 @@ L Lf(CR) L Lx.
 .SS Brackets
 .\" ====================================================================
 .
-On typestter devices,
+On typesetting devices,
 the bracket extensions are font-invariant glyphs;
 that is,
 they are rendered the same way regardless of font
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 96e007ee3..1bc125549 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4878,7 +4878,7 @@ delim off
 .
 .
 .P
-Fill colors are implmenented with another set of extensions.
+Fill colors are implemented with another set of extensions.
 .
 .
 .TP
diff --git a/man/roff.7.man b/man/roff.7.man
index 1a4c52f48..93b2ed96b 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -567,7 +567,7 @@ If drawn at the origin,
 a typical letter glyph would lie partially or wholly off the page,
 depending on whether,
 like \[lq]g\[rq],
-it features a decender below the baseline.
+it features a descender below the baseline.
 .
 .
 .P
@@ -1186,7 +1186,7 @@ the Bell Labs site in Murray Hill acquired a Graphic 
Systems C/A/T
 phototypesetter,
 and with it came the necessity of expanding the capabilities of a
 .I roff
-system to cope with a variety of proportionally-spaced typefaces at
+system to cope with a variety of proportionally spaced typefaces at
 multiple sizes.
 .
 Ossanna wrote a parallel implementation of
@@ -1420,7 +1420,7 @@ it has been used by practically all GNU/Linux and BSD 
operating systems.
 continues to be developed,
 is available for almost all operating systems in common use
 (along with several obscure ones),
-and it is free.
+and is free.
 .
 These factors make
 .I groff
@@ -1855,7 +1855,7 @@ Eric Allman),
 (from \[lq]memorandum macros\[rq]),
 and
 .IR mom ,
-a punningly-named package exercising many
+a punningly named package exercising many
 .I groff
 extensions.
 .
@@ -1879,7 +1879,7 @@ string variables,
 registers for storage of numbers or dimensions,
 and control of execution flow.
 .
-The theoretically-minded will observe that a
+The theoretically minded will observe that a
 .I roff
 is not a mere markup language,
 but Turing-complete.
@@ -2441,7 +2441,7 @@ contributors and enthusiasts.
 an online article maintained by the mdocml project,
 provides an overview of
 .I roff
-development from Salzer's
+development from Saltzer's
 .I RUNOFF
 to 2008,
 with links to original documentation and recollections of the authors
diff --git a/src/roff/nroff/nroff.1.man b/src/roff/nroff/nroff.1.man
index 6ccc9d49f..cdefee129 100644
--- a/src/roff/nroff/nroff.1.man
+++ b/src/roff/nroff/nroff.1.man
@@ -313,7 +313,7 @@ defines fallback definitions of
 special characters.
 .
 These definitions more poorly optically approximate typeset output
-compared to those of
+than those of
 .I tty.tmac
 in favor of communicating semantic information.
 .
diff --git a/tmac/fallbacks.tmac b/tmac/fallbacks.tmac
index 31f27e4eb..162e57eea 100644
--- a/tmac/fallbacks.tmac
+++ b/tmac/fallbacks.tmac
@@ -158,7 +158,7 @@
 .fchar \[u2005] \h'1/4u'\" four-per-em space
 .fchar \[u2006] \h'1/6u'\" six-per-em space
 .fchar \[u2007] \0\" figure space
-.fchar \[u2008] \^\" puncutation space
+.fchar \[u2008] \^\" punctuation space
 .fchar \[u2009] \|\" thin space
 .fchar \[u200A] \^\" hair space
 .\" Mapping U+200B awaits resolution of Savannah #58958.



reply via email to

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