groff-commit
[Top][All Lists]
Advanced

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

[groff] 29/49: groff_doc(7): Fix style, markup nits in intro.


From: G. Branden Robinson
Subject: [groff] 29/49: groff_doc(7): Fix style, markup nits in intro.
Date: Sun, 6 Nov 2022 00:37:21 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 9804460c335c9670bc734f32e692e610c404240d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Nov 3 09:15:25 2022 -0500

    groff_doc(7): Fix style, markup nits in intro.
    
    * Break input lines after commas.
    * Use an empty request between sentences.
    * Recast final sentence to avoid hackneyed "hopefully".
---
 tmac/groff_mdoc.7.man | 32 ++++++++++++++++++++++----------
 1 file changed, 22 insertions(+), 10 deletions(-)

diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index 8b093f4f9..8c9f9c01b 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -98,24 +98,36 @@ displays,
 and lists\[em]essentially items which affect the physical position of
 text on a formatted page.
 .
-In addition to the page structure domain, there are two more domains, the
+In addition to the page structure domain,
+there are two more domains,
+the
 .Em manual
 domain and the
 .Em general
 text domain.
 The general text domain is defined as macros which perform tasks such as
 quoting or emphasizing pieces of text.
-The manual domain is defined as macros that are a subset of the day to day
-informal language used to describe commands, routines and related
+.
+The manual domain is defined as macros that are a subset of the day to
+day informal language used to describe commands,
+routines and related
 .Ux
 files.
-Macros in the manual domain handle command names, command-line arguments and
-options, function names, function parameters, pathnames, variables, cross
-references to other manual pages, and so on.
-These domain items have value for both the author and the future user of the
-manual page.
-Hopefully, the consistency gained across the manual set will provide easier
-translation to future documentation tools.
+.
+Macros in the manual domain handle command names,
+command-line arguments and options,
+function names,
+function parameters,
+pathnames,
+variables,
+cross references to other manual pages,
+and so on.
+.
+These domain items have value for both the author and the future user of
+the manual page.
+.
+It is hoped that the resulting increased consistency of the man page
+corpus will enable easier translation to future documentation tools.
 .
 .
 .Pp



reply via email to

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