bug-groff
[Top][All Lists]
Advanced

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

[bug #59920] [PATCH] -me documentation terminology cleanup


From: Dave
Subject: [bug #59920] [PATCH] -me documentation terminology cleanup
Date: Wed, 20 Jan 2021 22:57:35 -0500 (EST)
User-agent: Mozilla/5.0 (X11; Linux i686; rv:45.0) Gecko/20100101 Firefox/45.0

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

                 Summary: [PATCH] -me documentation terminology cleanup
                 Project: GNU troff
            Submitted by: barx
            Submitted on: Wed 20 Jan 2021 09:57:34 PM CST
                Category: Macro - me
                Severity: 2 - Minor
              Item Group: Documentation
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None

    _______________________________________________________

Details:

Historical and modern *roff documentation is careful to exclusively use the
term "request" for what coders more conventionally call a "command."

doc/meref.me largely follows this practice, but slips up in a couple places,
using "command" for *roff requests.  This patch fixes those.

While it's at it, it fixes a few places where "request" or "command"
erroneously refers to a macro.

The situation in doc/meintro.me is trickier.  This document pervasively calls
macros defined by the -me package "requests," and reserves the term "macro"
for macros the user defines in his own -me document.  While not strictly
accurate, this slight muddying is consistent and probably fine for the
intended (novice) audience of this document.

The sole exception to this consistency is text I wrote that was added in
commit 7a83f7f50
<http://git.savannah.gnu.org/cgit/groff.git/commit/?id=7a83f7f50>, which calls
.bl a macro--technically accurate but inconsistent with the rest of the
document's usage.  Thus this patch changes this word to "request."

The one use of "command" in meintro.me is also changed to "request" following
similar logic.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Wed 20 Jan 2021 09:57:34 PM CST  Name: me_terminology_cleanup.patch 
Size: 2KiB   By: barx

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

    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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