🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: gnu.emacs.bug
Article #99600

Re: documentation for `up-list'

#99600
From: Randal Schwartz
Date: Tue, 24 Jul 1990 05:54
23 lines
1944 bytes
In article <9007232241.AA09881@noname>, eric%yamada-sun writes:
| The documentation for the function `up-list' reads like this:
| 	up-list:
| 	Move forward out of one level of parentheses.
| 	With argument, do this that many times.
| 	A negative argument means move backward but still to a less deep spot.
| This gives the impression that the argument is optional.  However, the
| code reads like this:
| 	(defun up-list (arg) 
| which says to me that the argument is required, not optional.

The argument is required from elisp, but optional from the keyboard.
In general, a doc-string talks about ARG being optional if it means
the elisp argument, rather than "the argument is optional", which
nearly always means the prefix argument if the function is
keybindable; that is, the function contains an "(interactive...)".

Just another elisp hacker,
-- 
/=Randal L. Schwartz, Stonehenge Consulting Services (503)777-0095 ==========\
| on contract to Intel's iWarp project, Beaverton, Oregon, USA, Sol III      |
| merlyn@iwarp.intel.com ...!any-MX-mailer-like-uunet!iwarp.intel.com!merlyn |
\=Cute Quote: "Welcome to Portland, Oregon, home of the California Raisins!"=/
Technical Details
Message-ID: <1990Jul24.055439.16123@iwarp.intel.com>
Path: arc1-ca.pugleaf.net!gmdzi!unido!mcsun!uunet!tut.cis.ohio-state.edu!ucbvax!iwarp.intel.com!news
References: <9007232241.AA09881@noname>

Show Full Headers
Complete Article Headers
X-Google-Language: ENGLISH,ASCII-7-bit
X-Google-Thread: fb2f1,a67cc6f24e56c842
X-Google-Attributes: gidfb2f1,public
X-Google-ArrivalTime: 1990-07-24 02:18:15 PST
Path: arc1-ca.pugleaf.net!gmdzi!unido!mcsun!uunet!tut.cis.ohio-state.edu!ucbvax!iwarp.intel.com!news
From: merlyn@iwarp.intel.com (Randal Schwartz)
Newsgroups: gnu.emacs.bug
Subject: Re: documentation for `up-list'
Message-ID: <1990Jul24.055439.16123@iwarp.intel.com>
Date: 24 Jul 90 05:54:39 GMT
References: <9007232241.AA09881@noname>
Sender: news@iwarp.intel.com
Reply-To: merlyn@iwarp.intel.com (Randal Schwartz)
Distribution: gnu
Organization: Stonehenge; netaccess via Intel, Beaverton, Oregon, USA
Lines: 23
Posted: Tue Jul 24 06:54:39 1990
In-Reply-To: eric%yamada-sun@CSE.OGI.EDU