groff-commit
[Top][All Lists]
Advanced

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

[groff] 06/06: [ms]: Fix style nits in documentation.


From: G. Branden Robinson
Subject: [groff] 06/06: [ms]: Fix style nits in documentation.
Date: Fri, 4 Oct 2024 06:49:36 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit be138ce192507d6e8d1ee71d66d766fa3ad54d10
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Oct 4 05:26:23 2024 -0500

    [ms]: Fix style nits in documentation.
    
    * Favor active voice over passive.
    * Tighten wording, unstranding a line.
---
 doc/groff.texi.in   | 18 +++++++++---------
 doc/ms.ms           | 29 ++++++++++++++++-------------
 tmac/groff_ms.7.man | 31 +++++++++++++++++--------------
 3 files changed, 42 insertions(+), 36 deletions(-)

diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 6288d47be..98d05bfb2 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -4058,15 +4058,16 @@ P V = n R T
 @cindex equations [@file{ms}]
 @cindex references [@file{ms}]
 
-The @file{ms} package is often used with the @code{tbl}, @code{pic},
-@code{eqn}, and @code{refer} preprocessors.
+@file{ms} often sees use with the @code{tbl}, @code{pic}, @code{eqn},
+and @code{refer} preprocessors.
 @pindex tbl
 @pindex pic
 @pindex eqn
 @pindex refer
 Mark text meant for preprocessors by enclosing it in pairs of tokens
-as follows, with nothing between the dot and the macro name.  The
-preprocessors match these tokens only at the start of an input line.
+as follows, with nothing between the dot and the macro name.
+Preprocessors match these tokens only at the start of an input line.
+@code{troff} interprets them as macro calls.
 
 @DefmacList {TS, [@code{H}], ms}
 @DefmacListEndx {TE, , ms}
@@ -4742,11 +4743,10 @@ register; Berkeley and @code{groff} @file{ms} do.
 @end itemize
 
 @Defmpreg {GS, ms}
-The register @code{GS} is set to@tie{}1 by the @code{groff} @file{ms}
-macros, but is not used by the @acronym{AT&T} @file{ms} package.
-Documents that need to determine whether they are being formatted with
-@code{groff} @file{ms} or another implementation should test this
-register.
+@code{groff} @file{ms} sets the register @code{GS} to@tie{}1;
+@acronym{AT&T} @file{ms} does not use it.  A document can test its value
+to determine whether it is being formatted with @code{groff} @file{ms}
+or another implementation.
 @endDefmpreg
 
 @menu
diff --git a/doc/ms.ms b/doc/ms.ms
index 7ee6cf102..66b3ffed4 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -2433,9 +2433,8 @@ Tables, figures, equations, and references
        Tables, figures, equations, and references
 .XE
 .LP
-The
 .I ms
-package is often used with the
+often sees use with the
 .I tbl ,
 .I pic ,
 .I eqn ,
@@ -2443,9 +2442,10 @@ and
 .I refer
 preprocessors.
 .
-The
+.I "groff ms"
+applies the
 .CW \[rs]n[DD]
-distance is also applied to regions of the document preprocessed with
+distance to regions of the document preprocessed with
 .I tbl ,
 .I pic ,
 and
@@ -2455,7 +2455,10 @@ Mark text meant for preprocessors by enclosing it in 
pairs of tokens as
 follows,
 with nothing between the dot and the macro name.
 .
-The preprocessors match these tokens only at the start of an input line.
+Preprocessors match these tokens only at the start of an input line.
+.
+.I troff
+interprets them as macro calls.
 .
 .
 .TS
@@ -4232,18 +4235,18 @@ do.
 .
 .
 .PP
-The register
-.CW GS
-is set to\~1 by the
 .I "groff ms"
-macros,
-but is not used by the AT&T
+sets the register
+.CW GS
+to\~1;
+the AT&T
 .I ms
-package.
+package does not use it.
 .
-Documents that need to determine whether they are being formatted with
+A document can test its value to determine whether it is being formatted
+with
 .I "groff ms"
-or another implementation should test this register.
+or another implementation.
 .
 .
 .\" XXX: We can't use a keep here because the wrong page number will be
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index e8cd64697..c53f2ec15 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1489,9 +1489,8 @@ Changes to either register take effect at the next 
display boundary.
 .SS "Tables, figures, equations, and references"
 .\" ====================================================================
 .
-The
 .I ms
-package is often used with the
+often sees use with the
 .IR @g@tbl ,
 .IR @g@pic ,
 .IR @g@eqn ,
@@ -1499,9 +1498,10 @@ and
 .I @g@refer
 preprocessors.
 .
-The
+.I "groff ms"
+applies the
 .B \[rs]n[DD]
-distance is also applied to regions of the document preprocessed with
+distance to regions of the document preprocessed with
 .IR @g@eqn ,
 .IR @g@pic ,
 and
@@ -1511,7 +1511,10 @@ Mark text meant for preprocessors by enclosing it in 
pairs of tokens as
 follows,
 with nothing between the dot and the macro name.
 .
-The preprocessors match these tokens only at the start of an input line.
+Preprocessors match these tokens only at the start of an input line.
+.
+.I troff \" generic
+interprets them as macro calls.
 .
 .
 .TP
@@ -2605,18 +2608,18 @@ do.
 .
 .
 .IP \[bu]
-The register
+.I "groff ms"
+sets the register
 .B GS
-is set to\~1 by the
-.I groff ms
-macros,
-but is not used by the AT&T
+to\~1;
+the AT&T
 .I ms
-package.
+package does not use it.
 .
-Documents that need to determine whether they are being formatted with
-.I groff ms
-or another implementation should test this register.
+A document can test its value to determine whether it is being formatted
+with
+.I "groff ms"
+or another implementation.
 .
 .
 .\" ====================================================================



reply via email to

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