unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Robert J. Chassell" <bob@rattlesnake.com>
Cc: emacs-devel@gnu.org
Subject: Re: Optional third argument - name not mentioned in docstring
Date: Tue, 10 Jan 2006 18:53:07 +0000 (UTC)	[thread overview]
Message-ID: <m1EwOcF-0004EoC@rattlesnake.com> (raw)
In-Reply-To: <43C3DDAD.4030600@student.lu.se> (message from Lennart Borgman on Tue, 10 Jan 2006 17:15:41 +0100)

   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

  reply	other threads:[~2006-01-10 18:53 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-01-10 16:15 Optional third argument - name not mentioned in docstring Lennart Borgman
2006-01-10 18:53 ` Robert J. Chassell [this message]
2006-01-11 13:55 ` Richard M. Stallman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m1EwOcF-0004EoC@rattlesnake.com \
    --to=bob@rattlesnake.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).