[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug #59920] [PATCH] -me documentation terminology cleanup
From: |
G. Branden Robinson |
Subject: |
[bug #59920] [PATCH] -me documentation terminology cleanup |
Date: |
Wed, 10 Feb 2021 01:55:27 -0500 (EST) |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Firefox/78.0 |
Update of bug #59920 (project groff):
Status: In Progress => Fixed
Open/Closed: Open => Closed
Planned Release: None => 1.23.0
_______________________________________________________
Follow-up Comment #1:
commit 84d8a288b0a685fa1447dc706e567be798ac2058
Author: Dave Kemper <saint.snit@gmail.com>
AuthorDate: Thu Jan 21 03:57:34 2021 +0000
Commit: G. Branden Robinson <g.branden.robinson@gmail.com>
CommitDate: Thu Feb 4 14:08:57 2021 +1100
doc/me{intro,ref}.me: Use consistent terminology.
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, 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.
_______________________________________________________
Reply to this item at:
<https://savannah.gnu.org/bugs/?59920>
_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/