unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Optional third argument - name not mentioned in docstring
@ 2006-01-10 16:15 Lennart Borgman
  2006-01-10 18:53 ` Robert J. Chassell
  2006-01-11 13:55 ` Richard M. Stallman
  0 siblings, 2 replies; 3+ messages in thread
From: Lennart Borgman @ 2006-01-10 16:15 UTC (permalink / raw)


In the doc strings for `search-forward' and `search-backward' the 
argument names "bound" etc are not mentioned. Instead the doc strings 
just says:

    Optional third argument, if t, ...

Should not the names be mentioned?

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Optional third argument - name not mentioned in docstring
  2006-01-10 16:15 Optional third argument - name not mentioned in docstring Lennart Borgman
@ 2006-01-10 18:53 ` Robert J. Chassell
  2006-01-11 13:55 ` Richard M. Stallman
  1 sibling, 0 replies; 3+ messages in thread
From: Robert J. Chassell @ 2006-01-10 18:53 UTC (permalink / raw)
  Cc: emacs-devel

   In the doc strings for `search-forward' and `search-backward' the 
   argument names "bound" etc are not mentioned. Instead the doc strings 
   just says:

       Optional third argument, if t, ...

   Should not the names be mentioned?

No,   I just read the doc string from describe-function and it says

    An optional second argument bounds the search; it is a buffer position.

which is entirely clear.  Indeed, I find the rest of the documentation
clear, too:

    Optional third argument, if t, means if fail just return nil (no error).
      If not nil and not t, move to limit of search and return nil.
    Optional fourth argument is repeat count--search for successive occurrences.

-- 
    Robert J. Chassell                         
    bob@rattlesnake.com                         GnuPG Key ID: 004B4AC8
    http://www.rattlesnake.com                  http://www.teak.cc

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Optional third argument - name not mentioned in docstring
  2006-01-10 16:15 Optional third argument - name not mentioned in docstring Lennart Borgman
  2006-01-10 18:53 ` Robert J. Chassell
@ 2006-01-11 13:55 ` Richard M. Stallman
  1 sibling, 0 replies; 3+ messages in thread
From: Richard M. Stallman @ 2006-01-11 13:55 UTC (permalink / raw)
  Cc: emacs-devel

    In the doc strings for `search-forward' and `search-backward' the 
    argument names "bound" etc are not mentioned. Instead the doc strings 
    just says:

	Optional third argument, if t, ...

    Should not the names be mentioned?

It is better to mention the names, but I'd rather not go on a campaign
just now to change them all.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2006-01-11 13:55 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-01-10 16:15 Optional third argument - name not mentioned in docstring Lennart Borgman
2006-01-10 18:53 ` Robert J. Chassell
2006-01-11 13:55 ` Richard M. Stallman

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).