groff-commit
[Top][All Lists]
Advanced

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

[groff] 29/45: [ms]: Fix content and style nits in documentation.


From: G. Branden Robinson
Subject: [groff] 29/45: [ms]: Fix content and style nits in documentation.
Date: Thu, 20 Jan 2022 10:17:52 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 9e81bc22a45c00ee80406c6b4e4879815a79461e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jan 18 12:32:21 2022 +1100

    [ms]: Fix content and style nits in documentation.
    
    Content:
    * Say hyphenation "mode", not "flags".
    
    Style:
    * Remove redundant phrase where "also" has already done its work.
    * Fix awkward wording; it is _changes_ to the `FAM` register that
      take effect, not the string itself.
---
 doc/groff.texi      | 14 +++++++-------
 doc/ms.ms           | 11 +++++------
 tmac/groff_ms.7.man |  7 +++----
 3 files changed, 15 insertions(+), 17 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 8aadbfd8..157ce677 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3147,10 +3147,10 @@ The @code{FAM} string sets the font family for body 
text.  If this
 string is undefined at initialization, it is set to @samp{T} (Times).
 Setting the @code{FAM} string before the first call of a sectioning,
 paragraphing, or (non-date) document description macro also applies it
-to headers, footers, and footnotes (as well as the body text).
+to headers, footers, and footnotes.
 
-The hyphenation flags (as used by the @code{hy} request) are set using
-the @code{HY} register.
+The hyphenation mode (as used by the @code{hy} request) is set from the
+@code{HY} register.
 
 @menu
 * Paragraphs in ms::
@@ -3494,10 +3494,10 @@ Rather than calling the @code{CW} macro, in 
@code{groff} @file{ms} you
 might prefer to change the font family to Courier---a monospaced
 typeface---by setting the @code{FAM} string to @samp{C}.  You can then
 use all four style macros above, returning to the default family (Times)
-with @samp{.ds FAM T}.  Because @code{FAM} takes effect at the next
-paragraph, @code{CW} remains useful to ``inline'' a change to the font
-family, similarly to the practice of this document in noting syntactical
-elements of @file{ms} and @code{groff}.
+with @samp{.ds FAM T}.  Because changes to @code{FAM} take effect only
+at the next paragraph, @code{CW} remains useful to ``inline'' a change
+to the font family, similarly to the practice of this document in noting
+syntactical elements of @file{ms} and @code{groff}.
 
 @c ---------------------------------------------------------------------
 
diff --git a/doc/ms.ms b/doc/ms.ms
index 90835bd6..fe218b85 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -694,16 +694,15 @@ before the first call of a sectioning,
 paragraphing,
 or (non-date) document description macro also applies it to headers,
 footers,
-and footnotes
-(as well as the body text).
+and footnotes.
 .
 .
 .PP
-The hyphenation flags
+The hyphenation mode
 (as used by the
 .CW hy
 request)
-are set using the
+is set from the
 .CW HY
 register.
 .KE
@@ -1412,9 +1411,9 @@ You can then use all four style macros above,
 returning to the default family (Times) with
 .CW ".ds FAM T" \[rq]. \[lq]
 .
-Because
+Because changes to
 .CW \[rs]*[FAM]
-takes effect at the next paragraph,
+take effect only at the next paragraph,
 this document uses
 .CW .CW
 to \[lq]inline\[rq] a change to the font family,
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 19b20c83..6f7671ef 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -574,16 +574,15 @@ before the first call of a sectioning,
 paragraphing,
 or (non-date) document description macro also applies it to headers,
 footers,
-and footnotes
-(as well as the body text).
+and footnotes.
 .
 .
 .P
-The hyphenation flags
+The hyphenation mode
 (as used by the
 .B hy
 request)
-are set using the
+is set from the
 .B HY
 register.
 .



reply via email to

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