[bug #62551] [PATCH] doc/groff.texi: Fix content and style nits

[Dave]

URL:
  <https://savannah.gnu.org/bugs/?62551>

                 Summary: [PATCH] doc/groff.texi: Fix content and style nits
                 Project: GNU troff
               Submitter: barx
               Submitted: Tue 31 May 2022 01:24:11 PM CDT
                Category: Core
                Severity: 2 - Minor
              Item Group: Documentation
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Tue 31 May 2022 01:24:11 PM CDT By: Dave <barx>
What this patch does:


    doc/groff.texi: Fix content and style nits.

    * Remove redundancy ("fixed-width... character that can't be adjusted")
    * Fix incorrect word ("environment value" -> "environment variable")
    * Add or change the placement of a couple tie{}s to comport with
      style-guide recommendation
    * Grammarify
    * Clarify and tighten wording


Possible controversial points about this patch:

* In a couple cases I removed what I consider to be excess verbiage; if you
feel any removed wording removes useful information, feel free to excise that
part of the patch.

* The Chicago Manual of Style (see the answer to the first question on
http://www.chicagomanualofstyle.org/qanda/data/faq/topics/WordDivision.html)
says it is "advisable to avoid a break... before (but not after) a middle
initial."  This is the opposite of what was being done with the names Trent A.
Fisher and Eric P. Allman.  The name J. F. Ossanna did follow CMOS style
here.

CMOS is not universally accepted, but I can also justify this styling on
purely typographic grounds if necessary (but I won't bore you if not).

The name Jerome H. Saltzer had no tie{}, and I have not added one, presuming
its omission was intentional based on the name's placement on the line. 
(However, one could also argue for marking up names consistently as a
defensive measure.)

The name M. E. Lesk had no tie{}.  I added one, presuming this was an
oversight, but it's possible this was also intentional (the name appears
inside a cite{}, if that matters).  This change can also be omitted if it
serves no purpose.

Trent's name appears in the manual's list of authors, and I can't find where
the author list (or any of the titlepage information) is actually displayed,
either through the info(1) interface, or in the groff.txt file generated by
the build.  So the placement of this tie{} may make no real-world difference.






    _______________________________________________________
File Attachments:


-------------------------------------------------------
Date: Tue 31 May 2022 01:24:11 PM CDT  Name: texinfo.patch  Size: 8KiB   By:
barx

<http://savannah.gnu.org/bugs/download.php?file_id=53263>

    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?62551>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/