bugGNU roff - Bugs: bug #54959, [PATCH] various minor...

 
 

bug #54959: [PATCH] various minor documentation corrections

Submitter:  Dave <barx>
Submitted:  Mon 05 Nov 2018 10:18:31 AM UTC
   
 
Category:  General Severity:  2 - Minor
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.22.4
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 15 Jun 2022 02:21:24 PM UTC, comment #2: 

I apparently didn't know about git commit's --author flag back then.


commit c62e62187df7e7939be8908d926dc020a1a24e68
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Nov 11 09:26:27 2018 -0500

    Fix minor documentation problems.

            Corrections courtesy of Dave <barx> via Savannah.  Thanks, Dave!

            * PROBLEMS:
            * doc/groff.texi: Fix typos.

            * doc/groff.texi:
              + Hyphenate "non-negative" as the rest of our documentation
                does.
              + Tighten wording.

            * doc/meref.me: Place less emphasis on the near-synonymy of
              macros and strings.

            * doc/pic.ms: Delete repeated phrase.

            Fixes most of <https://savannah.gnu.org/bugs/index.php?54959>.

commit b3055fda4bb37cf1e717d8e065ee517b1f33e28d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Nov 11 09:35:37 2018 -0500

    doc/groff.texi: Remove no-op request from example.

            Correction courtesy of Dave <barx> via Savannah.  Thanks, Dave!

            The example creates no @s string/macro/diversion, so there's no
            need to remove it.

            Fixes more of <https://savannah.gnu.org/bugs/index.php?54959>.

commit 92e41e2be5f9594a21b5472e22ba6d8df6245cd0
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Sun Nov 11 10:07:41 2018 -0500

    chem(1): Standardize options documentation.

            Dave <barx> via Savannah noted some bad grammar in the option
            documentation of chem(1).

            * contrib/chem/chem.1.man: Rewrite options documentation to
              conform with old conventions (like actually having an Options
              section) and newer ones (like standardized descriptions of
              help and version options, the only ones chem supports).

            Fixes rest of <https://savannah.gnu.org/bugs/index.php?54959>.


G. Branden Robinson <gbranden>
Group administrator
Sun 11 Nov 2018 04:18:27 PM UTC, comment #1: 

Fixed in c62e62187df7e7939be8908d926dc020a1a24e68, b3055fda4bb37cf1e717d8e065ee517b1f33e28d, and 92e41e2be5f9594a21b5472e22ba6d8df6245cd0.

G. Branden Robinson <gbranden>
Group administrator
Mon 05 Nov 2018 10:18:31 AM UTC, original submission:  

The attached patch fixes various (very minor) grammatical errors and typos in groff documentation files.  Most of its changes should be self-explanatory.  A couple that might need a little explanation:

 - http://www.merriam-webster.com/dictionary/nonnegative says that "nonnegative" should be spelled without a hyphen, but throughout the groff documentation, it is spelled "non-negative," so I changed the one instance of "nonnegative" to comply with the majority.

 - The groff.texi example for the dn and dl registers concluded with both a .rr @s and a .rm @s.  I removed the latter, which was unnecessary because the example code never defined @s as a macro, diversion, or string, only as a register.

This patch updates the files:

PROBLEMS
contrib/chem/chem.1.man
doc/groff.texi
doc/meref.me
doc/pic.ms

Dave <barx>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

Attached Files
file #45361:  groff.doc.patch added by barx (4KiB - text/x-patch)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Updated the item)
  • -email is unavailable- added by barx (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-15 gbranden CategoryNone General
    2018-11-11 gbranden Severity3 - Normal 2 - Minor
        StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.22.4
    2018-11-11 gbranden StatusNone In Progress
        Assigned toNone gbranden
    2018-11-05 barx Attached File- Added groff.doc.patch, #45361

    Back to the top

    Powered by Savane 3.13-caa5.
    Corresponding source code