all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 21754@debbugs.gnu.org
Subject: bug#21754: 25.0.50; doc of `grep' - no description of how to call it: COMMAND-ARGS undefined
Date: Sun, 25 Oct 2015 08:35:00 -0700 (PDT)	[thread overview]
Message-ID: <0ed13600-cfc4-42f8-8808-fe0c5e84500c@default> (raw)



Here is the entire doc string:

  (grep COMMAND-ARGS)

  Run grep, with user-specified args, and collect output in a buffer.
  While grep runs asynchronously, you can use C-x ` (M-x next-error),
  or RET in the *grep* buffer, to go to the lines where grep found
  matches.  To kill the grep job before it finishes, type C-c C-k.

  For doing a recursive 'grep', see the 'rgrep' command.  For running
  'grep' in a specific directory, see 'lgrep'.

  This command uses a special history list for its COMMAND-ARGS, so you
  can easily repeat a grep command.

  A prefix argument says to default the argument based upon the current
  tag the cursor is over, substituting it into the last grep command
  in the grep command history (or into 'grep-command' if that history
  list is empty).

There is _zero_ information here about parameter COMMAND-ARGS.
The Emacs and Elisp manuals offer no more help.

How is a user expected to call this function from Lisp?
Doc strings should _fully specify_ a function's parameters.


In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2015-10-09
Bzr revision: af45926d66d303fdc4c2c3ebbc820b4a54d9e4a0
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --host=i686-pc-mingw32 --enable-checking=yes,glyphs'





             reply	other threads:[~2015-10-25 15:35 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-25 15:35 Drew Adams [this message]
2015-10-25 20:06 ` bug#21754: 25.0.50; doc of `grep' - no description of how to call it: COMMAND-ARGS undefined Eli Zaretskii

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

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

  git send-email \
    --in-reply-to=0ed13600-cfc4-42f8-8808-fe0c5e84500c@default \
    --to=drew.adams@oracle.com \
    --cc=21754@debbugs.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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.