groff-commit
[Top][All Lists]
Advanced

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

[groff] 21/25: [ms]: Fix documentation style nits.


From: G. Branden Robinson
Subject: [groff] 21/25: [ms]: Fix documentation style nits.
Date: Mon, 28 Mar 2022 12:08:21 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 9e9b66d11bc686f82a7c5d3a7dc4ad34d0697ac8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Mar 29 01:34:51 2022 +1100

    [ms]: Fix documentation style nits.
    
    * Clarify that the `HY` register affects _automatic_ hyphenation.
    * Tighten wording.
---
 doc/groff.texi      | 17 ++++++++---------
 doc/ms.ms           |  9 +++++----
 tmac/groff_ms.7.man |  9 +++++----
 3 files changed, 18 insertions(+), 17 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 84c70cd0..9641bc76 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -2779,10 +2779,9 @@ Default: 12@dmn{p}.
 @endDefmpreg
 
 @Defmpreg {HY, ms}
-Defines the hyphenation mode.  @code{HY} safely sets the value of the
-low-level @code{hy} register.  Setting @code{HY} to@tie{}0 is equivalent
-to using the @code{nh} request.  This is a Tenth Edition Research Unix
-extension.
+Defines the automatic hyphenation mode used with the @code{hy} request.
+Setting @code{HY} to@tie{}0 is equivalent to using the @code{nh}
+request.  This is a Tenth Edition Research Unix extension.
 @c possibly 9th, but definitely not Berkeley
 
 Effective: next paragraph.
@@ -3200,9 +3199,9 @@ in the @code{PI} register.
 @Defmac {IP, [@Var{marker} [@Var{width}]], ms}
 Set a paragraph with a left indentation.  The optional @var{marker} is
 not indented and is empty by default.  It has several applications;
-see @ref{Lists in ms}.  @var{width} overrides the default indentation
-amount stored in the @code{PI} register; its default unit is @samp{n}.
-Once specified, @var{width} applies to further @code{IP} calls until
+see @ref{Lists in ms}.  @var{width} overrides the indentation amount
+stored in the @code{PI} register; its default unit is @samp{n}.  Once
+specified, @var{width} applies to further @code{IP} calls until
 specified again or a heading or different paragraphing macro is called.
 @endDefmac
 
@@ -3280,8 +3279,8 @@ Set an automatically numbered heading.
 any depth desired, with the numbering of each depth increasing
 automatically and being reset to zero when a more significant level is
 increased.  ``1''@tie{}is the most significant or coarsest division of
-the document.  Only nonzero values are output.  If the argument is
-omitted, @var{depth} is taken to be @samp{1}.
+the document.  Only nonzero values are output.  If @var{depth} is
+omitted, it is taken to be @samp{1}.
 
 If you specify @var{depth} such that an ascending gap occurs relative to
 the previous @code{NH} call---that is, you ``skip a depth'', as by
diff --git a/doc/ms.ms b/doc/ms.ms
index dca514e0..97c7cd6d 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -720,7 +720,7 @@ and footnotes.
 .PP
 The
 .CW HY
-register defines the hyphenation mode used with the
+register defines the automatic hyphenation mode used with the
 .CW hy
 request.
 .
@@ -805,7 +805,7 @@ It has several applications;
 see subsection \[lq]Lists\[rq] below.
 .
 .I width
-overrides the default indentation amount stored in
+overrides the indentation amount in
 .CW \[rs]n[PI] ;
 its default unit is
 .CW n \[rq]. \[lq]
@@ -951,9 +951,10 @@ document.
 .
 Only nonzero values are output.
 .
-If the argument is omitted,
+If
 .I depth
-is taken to be
+is omitted,
+it is taken to be
 .CW 1 .
 .
 If you specify
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 827d97dd..27f17fb2 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -628,7 +628,7 @@ and footnotes.
 .P
 The
 .B HY
-register defines the hyphenation mode used with the
+register defines the automatic hyphenation mode used with the
 .B hy
 request.
 .
@@ -702,7 +702,7 @@ The optional
 is not indented and is empty by default.
 .
 .I width
-overrides the default indentation amount of
+overrides the indentation amount in
 .BR \[rs]n[PI] ;
 its default unit is
 .RB \[lq] n \[rq].
@@ -789,9 +789,10 @@ the most significant or coarsest division of the document.
 .
 Only nonzero values are output.
 .
-If the argument is omitted,
+If
 .I depth
-is taken to be
+is omitted,
+it is taken to be
 .BR 1 .
 .
 If you specify



reply via email to

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