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

Previous Next

Package: emacs;

Reported by: MON KEY <monkey <at> sandpframing.com>

Date: Tue, 24 Aug 2010 22:13:01 UTC

Severity: minor

Tags: fixed

Done: Lars Magne Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 6904 in the body.
You can then email your comments to 6904 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#6904; Package emacs. (Tue, 24 Aug 2010 22:13:01 GMT) Full text and rfc822 format available.
Acknowledgement sent to MON KEY <monkey <at> sandpframing.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Tue, 24 Aug 2010 22:13:01 GMT) Full text and rfc822 format available.

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\
Information forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#6904; Package emacs. (Sat, 02 Jul 2011 14:07:02 GMT) Full text and rfc822 format available.

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: MON KEY <monkey <at> sandpframing.com>
Cc: 6904 <at> debbugs.gnu.org
Subject: Re: bug#6904: Documentation: `info-lookup-add-help'
Date: Sat, 02 Jul 2011 16:06:22 +0200

MON KEY <monkey <at> sandpframing.com> writes:

> | 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.

I've now clarified that ARGS is a list of pairs in Emacs 24.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/
Added tag(s) fixed. Request was from Lars Magne Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 02 Jul 2011 14:07:02 GMT) Full text and rfc822 format available.
bug closed, send any further explanations to 6904 <at> debbugs.gnu.org and MON KEY <monkey <at> sandpframing.com> Request was from Lars Magne Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 02 Jul 2011 14:07:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 31 Jul 2011 11:24:03 GMT) Full text and rfc822 format available.
This bug report was last modified 12 years and 279 days ago.

Previous Next

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