GNU bug report logs - #6904
Documentation: `info-lookup-add-help'

Previous Next

Full log

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: MON KEY <monkey <at> sandpframing.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Documentation: `info-lookup-add-help'
Date: Tue, 24 Aug 2010 18:08:19 -0400

Documentation `info-lookup-add-help'

,---- (documentation 'info-lookup-add-help)
|
| {...}
|
| Function arguments are one or more options of the form
|
|     KEYWORD ARGUMENT
|
| KEYWORD is either  :topic,  {...} or `:other-modes'.
|
| ARGUMENT has a value as explained in the documentation of the
|  variable `info-lookup-alist'.
|
`----

The either/or phrasing is confusing.
Should be something more like:

,----
| { ... }
|
| Arguments are specified as keyword/argument pairs.  The following
| arguments are defined:
|
| :topic, :mode, :regexp, :ignore-case,
| :doc-spec, :parse-rule,  and :other-modes.
|
| keyword argument pairs are as detailed in the variable
| `info-lookup-alist' which see.
|
| { ... }
`----

--
/s_P\

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.