🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: gnu.emacs.vm.bug
Article #9654

Re: \[---] documentation style

#9654
From: C. Michael Holloway
Date: Tue, 16 Apr 1991 11:17
46 lines
2705 bytes
>>>>> On Mon, 15 Apr 91 21:31:59 -0400, Dan_Jacobson@ATT.COM said:

dj> [VM 5.31] I believe that the, er, VM author's resistance to use the

dj>     `\[COMMAND]'
dj>           is replaced either by a keystroke sequence that will invoke
dj>           COMMAND, or by `M-x COMMAND' if COMMAND is not bound to any
dj>           key sequence.

dj> form of documentation has paid off big time [I marked all 1150 of my
dj> mailbox messages---ok, no big deal, but one day somebody might delete
dj> that many...]

dj> Exhibit A: C-h m output [evil falsehood]:
dj>        M m - mark the current message
dj>        M u - unmark the current message
dj>        M M - mark all messsages
dj>        M U - unmark all messsages <---ssspelled wrong too

dj> Exhibit B: C-h b output [reality]
dj> M u             vm-clear-all-marks
dj> M m             vm-mark-all-messages
dj> M U             vm-unmark-message
dj> M M             vm-mark-message
dj> M n             vm-next-command-uses-marks
dj> M N             vm-next-command-uses-marks

dj> Ladies & gentlemen of the jury, I urge you to convict Kyle on several
dj> counts of munged keybinding advertisement, and implore him to use
dj> Jamie Z's recently posted the-right-way style.

I disagree strongly here.  These exhibits show that Kyle is guilty of not
updating the documentation frequently enough; but that's all they show.  At
least on my system (Sun-3), frequent use of \[---] style documentation slows
down the help functions to the point of making them unusable.  (In fact, for
packages that use the \[---] style, I've started running C-h m once, storing
the results in a file, and them visiting this file when I need help.)

I, for one, hope that Kyle continues using his current style for documenting
VM. 

===================================================================
C. Michael Holloway               E-mail: cmh@phoebus.larc.nasa.gov
NASA Langley Research Center      FAX:    1 804 864 7891
Mail Stop 478                     Voice:  1 804 864 1701
Hampton VA 23665-5225             Verse:  Isaiah 1:18
Technical Details
Message-ID: <9104161117.AA09240@phoebus.larc.nasa.gov>
Path: arc1-ca.pugleaf.net!gmdzi!unido!fauern!ira.uka.de!sol.ctr.columbia.edu!zaphod.mps.ohio-state.edu!swrinde!cs.utexas.edu!uunet!wendy-fate.uu.net!bug-vm

Show Full Headers
Complete Article Headers
X-Google-Language: ENGLISH,ASCII-7-bit
X-Google-Thread: f6829,c823cd4621713dc2
X-Google-Attributes: gidf6829,public
X-Google-ArrivalTime: 1991-04-16 15:06:41 PST
Path: arc1-ca.pugleaf.net!gmdzi!unido!fauern!ira.uka.de!sol.ctr.columbia.edu!zaphod.mps.ohio-state.edu!swrinde!cs.utexas.edu!uunet!wendy-fate.uu.net!bug-vm
From: cmh@phoebus.larc.nasa.gov (C. Michael Holloway)
Newsgroups: gnu.emacs.vm.bug
Subject: Re: \[---] documentation style
Message-ID: <9104161117.AA09240@phoebus.larc.nasa.gov>
Date: 16 Apr 91 11:17:59 GMT
Sender: bug-vm-request@uunet.uu.net
Lines: 46
X-Verse-To-Know: Ephesians 4:29-32