Re: [drew.adams@oracle.com: links in Help buffer aren't always correct]

[Kevin Rodgers <ihs_4664@yahoo.com>]

Richard Stallman wrote:
> Would someone please DTRT about this, then ack?
> 
> ------- Start of forwarded message -------
> From: "Drew Adams" <drew.adams@oracle.com>
> To: "Emacs-Pretest-Bug" <emacs-pretest-bug@gnu.org>
> Date: Mon, 28 Nov 2005 08:58:08 -0800
> X-Brightmail-Tracker: AAAAAQAAAAI=
> X-Whitelist: TRUE
> Subject: links in Help buffer aren't always correct
> Sender: emacs-pretest-bug-bounces+rms=gnu.org@gnu.org
> X-Spam-Checker-Version: SpamAssassin 2.63 (2004-01-11) on monty-python
> X-Spam-Level: 
> X-Spam-Status: No, hits=0.0 required=5.0 tests=none autolearn=no version=2.63
> 
> For example, C-h f buffer-list shows this text:
> 
>  buffer-list is a built-in function in `C source code'.
>  (buffer-list &optional frame)
> 
>  Return a list of all existing live buffers.
>  If the optional arg frame is a frame, we return the buffer list
>  in the proper order for that frame: the buffers in frame's `buffer-list'
>  frame parameter come first, followed by the rest of the buffers.

I think it would be better to say:
   the buffers in FRAME's `buffer-list' frame parameter come first,
or:
   the buffers in the frame's `buffer-list' frame parameter come first,
or:
   the buffers in its `buffer-list' frame parameter come first,

>  [back]
> 
> The text "buffer-list" in the last sentence is linked to the help for the
> `buffer-list' function, not the `buffer-list' frame parameter. Either there
> should be no link here (if there is no way to show help on the parameter) or
> the link should point to help on the frame parameter.

Since there is no describe-frame-parameter command, and the phrase
"frame paramter" follows the quoted symbol (unlike the phrases listed
in help-xref-symbol-regexp, which precede quoted symbols), we can avoid
hyperlinking such phrases by changing help-make-xrefs in help-mode.el
from:

               ;; Quoted symbols
               (save-excursion
                 (while (re-search-forward help-xref-symbol-regexp nil t)
                   (let* ((data (match-string 8))
                          (sym (intern-soft data)))
                     (if sym

to:

               ;; Quoted symbols
               (save-excursion
                 (while (re-search-forward help-xref-symbol-regexp nil t)
                   (let* ((data (match-string 8))
                          (sym (intern-soft data)))
                     (if (and sym
                              (save-match-data
                                (not (looking-at "[ \t\n]+frame 
parameter"))))

-- 
Kevin Rodgers