Re: Elisp manual omission?

[Eli Zaretskii]

> From: Richard Stallman <address@hidden>
> CC: address@hidden, address@hidden
> Date: Sat, 23 Apr 2005 18:24:28 -0400
> 
>     > Which of these do Lisp programmers need to use, and when?
> 
>     It seems like tooltip-mode is used in several files, so at least that
>     function should be mentioned.
> 
> The place to document tooltip-mode, if we want to document it,
> is the Emacs manual.  It is a user-level command to enable or
> disable a user-level feature.

It is already in the user's manual, but I doubt that users actually
use tooltip-mode, since Emacs takes care of setting it up by default
according to the display capabilities.

I thought mentioning tooltip-mode in the ELisp manual was worthwhile
because some Lisp packages invoke it.

>       gdb-ui.el uses
>     tooltip-identifier-from-point and gud.el uses tooltip-toggle-gud-tips
>     and tooltip-gud-tips-p.
> 
> That doesn't necessarily mean they are worth mentioning in the Lisp
> Manual.

What does?  If there are some objective criteria, let's hear them.

>     Personally, I'd document the following:
> 
>     tooltip-frame-parameters, tooltip-hook, tooltip-mode, tooltip-show,
>     tooltip-hide, tooltip-identifier-from-point,
>     tooltip-show-help-function, tooltip-help-tips.
> 
> Why do you think those are worth documenting?

I tried to imagine what would I like to know if I needed to write a
mode with special tooltip support, similar to GUD (whose tooltip
support is part of tooltip.el).