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

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

[MON KEY]

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\

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

[Lars Magne Ingebrigtsen]

MON KEY <monkey@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/