groff-commit
[Top][All Lists]
Advanced

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

[groff] 09/26: [ms]: Fix style nits in docs.


From: G. Branden Robinson
Subject: [groff] 09/26: [ms]: Fix style nits in docs.
Date: Sun, 18 Dec 2022 20:41:31 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 2808fdf08d0a22d707e1011479bf317ffb6dc70e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Dec 17 13:02:29 2022 -0600

    [ms]: Fix style nits in docs.
    
    * doc/ms.ms (Typeface and decoration): Use passive voice after
      imperative summary; see commit 358ef64fdc, 10 December.
    
      (Glyphs for special characters): Add `\[aq]` and `\[dq]`.  Add "hat"
      to `\[ha]` description for mnemonic value.
    
      (Page layout, Margins): Tighten wording.
    
    * doc/groff.texi:
    * tmac/groff_ms.7.man: Sync with the above where applicable.
---
 doc/groff.texi      | 20 +++++++++-----------
 doc/ms.ms           | 33 ++++++++++++++++-----------------
 tmac/groff_ms.7.man | 14 ++++++--------
 3 files changed, 31 insertions(+), 36 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 5182ccf10..5d44e82d1 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3534,8 +3534,8 @@ use unbreakable space or horizontal motion escape 
sequences (@code{\~},
 @endDefmac
 
 @Defmac {UL, [@Var{text} [@Var{post}]], ms}
-Typeset @var{text} with an underline.  Set @var{post}, if present, after
-@var{text} with no intervening space.
+Typeset @var{text} with an underline.  @var{post}, if present, is set
+after @var{text} with no intervening space.
 @endDefmac
 
 @Defmac {LG, , ms}
@@ -4199,10 +4199,9 @@ English: @samp{January}, @samp{February}, and so on.
 @cindex @file{ms} macros, page layout
 @cindex page layout [@file{ms}]
 
-@file{ms}'s default page layout is simple: it arranges text a single
-column with the page number centered between hyphens in a header on each
-page except the first.  It produces no footers.  You can customize this
-arrangement extensively.
+@file{ms}'s default page layout arranges text in a single column with
+the page number between hyphens centered in a header on each page except
+the first, and produces no footers.  You can customize this arrangement.
 
 @menu
 * ms Headers and Footers::
@@ -4288,11 +4287,10 @@ Redefine this macro to create a different set of 
default tab stops.
 @subsubsection Margins
 @cindex @file{ms} macros, margins
 
-Control margins using registers.  See ``Margin Settings'' in @ref{ms
-Document Control Settings}.  There is no explicit right margin setting;
-the combination of page offset @code{\n[PO]} and line length
-@code{\n[LL]} provides the information necessary to derive the right
-margin.
+Control margins using the registers summarized in ``Margin settings'' in
+@ref{ms Document Control Settings} above.  There is no setting for the
+right margin; the combination of page offset @code{\n[PO]} and line
+length @code{\n[LL]} determines it.
 
 @c ---------------------------------------------------------------------
 
diff --git a/doc/ms.ms b/doc/ms.ms
index 51a924300..e4d930a23 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -1642,10 +1642,9 @@ Typeset
 with an
 .UL underline .
 .
-Set
 .I post,
 if present,
-after
+is set after
 .I text
 with no intervening space.
 T}
@@ -3075,10 +3074,12 @@ Input   Appearance      Description
 _
 \[rs][\-]      \[mi]   minus sign
 \[rs][\->]     \[->]   right arrow
+\[rs][aq]      \[aq]   neutral apostrophe
 \[rs][bu]      \[bu]   bullet
+\[rs][dq]      \[dq]   neutral double quote
 \[rs][dg]      \[dg]   dagger
 \[rs][em]      \[em]   em dash
-\[rs][ha]      \[ha]   circumflex accent (caret)
+\[rs][ha]      \[ha]   circumflex accent (caret, hat)
 \[rs][lg]      \[lq]   left double quotation mark
 \[rs][rq]      \[rq]   right double quotation mark
 \[rs][rs]      \[rs]   reverse solidus (backslash)
@@ -3096,17 +3097,16 @@ Page layout
 .XE
 .LP
 .I ms 's
-default page layout is simple:
-it arranges text in a single column
+default page layout arranges text
+in a single column
 with the page number
-centered between hyphens
-in a header
+between hyphens
+centered in a header
 on each page
-except the first.
-.
-It produces no footers.
+except the first,
+and produces no footers.
 .
-You can customize this arrangement extensively.
+You can customize this arrangement.
 .
 .
 .NH 2
@@ -3295,17 +3295,16 @@ Margins
 .
 .
 .LP
-Control margins using registers.
-.
-These are summarized in the \[lq]Margins\[rq] portion of the table in
-section \[lq]Document control settings\[rq] above.
+Control margins using the registers summarized in the \[lq]Margins\[rq]
+portion of the table in section \[lq]Document control settings\[rq]
+above.
 .
-There is no explicit right margin setting;
+There is no setting for the right margin;
 the combination of page offset
 .CW \[rs]n[PO]
 and line length
 .CW \[rs]n[LL]
-provides the information necessary to derive the right margin.
+determines it.
 .KE
 .
 .
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 1ad3098f8..b54fc07da 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1138,10 +1138,9 @@ Typeset
 .I text
 with an underline.
 .
-Set
 .I post,
 if present,
-after
+is set after
 .I text
 with no intervening space.
 .
@@ -1958,17 +1957,16 @@ Redefine this macro to create a different set of 
default tab stops.
 .SS Margins
 .\" ====================================================================
 .
-Control margins using registers.
-.
-These are summarized in the \[lq]Margin settings\[rq] table in
-subsection \[lq]Document control settings\[rq] above.
+Control margins using the registers summarized in the \[lq]Margins\[rq]
+portion of the table in section \[lq]Document control settings\[rq]
+above.
 .
-There is no explicit right margin setting;
+There is no setting for the right margin;
 the combination of page offset
 .B \[rs]n[PO]
 and line length
 .B \[rs]n[LL]
-provides the information necessary to derive the right margin.
+determines it.
 .
 .
 .\" ====================================================================



reply via email to

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