emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: locate-with-filter


From: Luc Teirlinck
Subject: Re: locate-with-filter
Date: Thu, 16 Mar 2006 20:21:01 -0600 (CST)

In my previous reply, I forgot to mention that the docstrings of
`help-follow' and `help-make-xrefs' are out of date.  The same may be
true for other docstrings referring to `help-follow'.

`help-follow' docstring:

  Follow cross-reference at POS, defaulting to point.

  For the cross-reference format, see `help-make-xrefs'.

That is inaccurate.  What `help-follow' does in a Help buffer is check
whether the word under point (or at position POS) is a variable,
function or face and show the corresponding docstring if it is any of
these three.  It does this even if that word is not an xref.  It has
nothing to do with `help-make-xrefs'.  The command that follows
explicit author-intended cross references is `push-button', not `help-follow'.

Beginning of `help-make-xrefs' docstring:

  Parse and hyperlink documentation cross-references in the given buffer.

  Find cross-reference information in a buffer and activate such cross
  references for selection with `help-follow'.

It activates such cross-references for selection with `push-button',
not for selection with `help-follow'.   Quite to the contrary, it
makes sure that the usual RET and mouse-2 bindings for help-follow are
_shadowed_ by `push-button'.

Somewhat counterintuitively, an explicit link never enables a link
that would not be there without the explicit link anyway.  All it does
is make the following of the link more restrictive using various
conventions.

Sincerely,

Luc.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]