* tooltip-mode docstring
@ 2006-01-10 3:21 Luc Teirlinck
[not found] ` <17347.11883.424247.69329@kahikatea.snap.net.nz>
0 siblings, 1 reply; 5+ messages in thread
From: Luc Teirlinck @ 2006-01-10 3:21 UTC (permalink / raw)
The docstring of tooltip-mode does not seem very helpful. It
misleadingly suggests that if you disable it, you do not get to see
any help-text on mouse-over, whereas tooltip-mode only determines
_where_ you see that thext rather than _whether_ you see it.
Unless there are objections, I plan to install the following doc fix:
===File ~/tooltip-diff======================================
*** tooltip.el 20 Dec 2005 15:59:43 -0600 1.72
--- tooltip.el 09 Jan 2006 21:14:26 -0600
***************
*** 48,54 ****
(define-minor-mode tooltip-mode
"Toggle Tooltip display.
! With ARG, turn tooltip mode on if and only if ARG is positive."
:global t
:init-value (not (or noninteractive
emacs-basic-display
--- 48,57 ----
(define-minor-mode tooltip-mode
"Toggle Tooltip display.
! With ARG, turn tooltip mode on if and only if ARG is positive.
! When this minor mode is enabled, Emacs displays help text
! in a pop-up tooltip on mouse-over. When it is disabled,
! Emacs displays the help text in the echo area instead."
:global t
:init-value (not (or noninteractive
emacs-basic-display
============================================================
^ permalink raw reply [flat|nested] 5+ messages in thread[parent not found: <17347.11883.424247.69329@kahikatea.snap.net.nz>]
* Re: tooltip-mode docstring [not found] ` <17347.11883.424247.69329@kahikatea.snap.net.nz> @ 2006-01-10 3:58 ` Luc Teirlinck 2006-01-10 6:08 ` Nick Roberts 0 siblings, 1 reply; 5+ messages in thread From: Luc Teirlinck @ 2006-01-10 3:58 UTC (permalink / raw) Cc: emacs-devel Nick Roberts wrote: A tooltip is, by definition, a window that pops up on mouse-over (it's called balloon help in the manual). This assumes that the reader knows this. What about just replacing "tooltip" in my original text with "window" to avoid redundancy: ===File ~/tooltip-diff====================================== *** tooltip.el 20 Dec 2005 15:59:43 -0600 1.72 --- tooltip.el 09 Jan 2006 21:14:26 -0600 *************** *** 48,54 **** (define-minor-mode tooltip-mode "Toggle Tooltip display. ! With ARG, turn tooltip mode on if and only if ARG is positive." :global t :init-value (not (or noninteractive emacs-basic-display --- 48,57 ---- (define-minor-mode tooltip-mode "Toggle Tooltip display. ! With ARG, turn tooltip mode on if and only if ARG is positive. ! When this minor mode is enabled, Emacs displays help text ! in a pop-up window on mouse-over. When it is disabled, ! Emacs displays the help text in the echo area instead." :global t :init-value (not (or noninteractive emacs-basic-display ============================================================ ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: tooltip-mode docstring 2006-01-10 3:58 ` Luc Teirlinck @ 2006-01-10 6:08 ` Nick Roberts 2006-01-10 15:37 ` Luc Teirlinck 2006-01-11 0:49 ` Richard M. Stallman 0 siblings, 2 replies; 5+ messages in thread From: Nick Roberts @ 2006-01-10 6:08 UTC (permalink / raw) Cc: emacs-devel > A tooltip is, by definition, a window that pops up on mouse-over (it's > called balloon help in the manual). > > This assumes that the reader knows this. I think it's reasonable to start with certain assumptions. It's a doc string, not a primer (or legal document). tool-bar-mode doesn't explain what a tool bar is, menu-bar-mode what a menu-bar is... Nick ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: tooltip-mode docstring 2006-01-10 6:08 ` Nick Roberts @ 2006-01-10 15:37 ` Luc Teirlinck 2006-01-11 0:49 ` Richard M. Stallman 1 sibling, 0 replies; 5+ messages in thread From: Luc Teirlinck @ 2006-01-10 15:37 UTC (permalink / raw) Cc: emacs-devel Nick Roberts wrote: I think it's reasonable to start with certain assumptions. It's a doc string, not a primer (or legal document). tool-bar-mode doesn't explain what a tool bar is, menu-bar-mode what a menu-bar is... "Tooltip" is sometimes misunderstood to mean the help message instead of the window showing that message. The purpose of my proposed doc fix is to prevent that confusion. Sincerely, Luc. ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: tooltip-mode docstring 2006-01-10 6:08 ` Nick Roberts 2006-01-10 15:37 ` Luc Teirlinck @ 2006-01-11 0:49 ` Richard M. Stallman 1 sibling, 0 replies; 5+ messages in thread From: Richard M. Stallman @ 2006-01-11 0:49 UTC (permalink / raw) Cc: teirllm, emacs-devel I think it's reasonable to start with certain assumptions. It's a doc string, not a primer (or legal document). tool-bar-mode doesn't explain what a tool bar is, menu-bar-mode what a menu-bar is... Tooltips are more obscure than menu bars. I think it won't hurt to make that doc string say what a tooltip is. ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2006-01-11 0:49 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-01-10 3:21 tooltip-mode docstring Luc Teirlinck
[not found] ` <17347.11883.424247.69329@kahikatea.snap.net.nz>
2006-01-10 3:58 ` Luc Teirlinck
2006-01-10 6:08 ` Nick Roberts
2006-01-10 15:37 ` Luc Teirlinck
2006-01-11 0:49 ` Richard M. Stallman
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/emacs.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).