GNU bug report logs - #54288
28.0.91; which-func documentation error

Previous Next

Package: emacs;

Reported by: sebastian <at> bsnrg.net

Date: Mon, 7 Mar 2022 08:22:02 UTC

Severity: normal

Found in version 28.0.91

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 54288 in the body.
You can then email your comments to 54288 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#54288; Package emacs. (Mon, 07 Mar 2022 08:22:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to sebastian <at> bsnrg.net:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 07 Mar 2022 08:22:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: sebastian <at> bsnrg.net
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.91; which-func documentation error
Date: Mon, 07 Mar 2022 08:21:00 +0000

In which-func.el there is the following function:

(defun which-func-update ()
  "Update the Which-Function mode display for all windows."
  ;; (walk-windows 'which-func-update-1 nil 'visible))
  (let ((non-essential t))
    (which-func-update-1 (selected-window))))

The doc string is incorrect, since the function only updates the selected window. In fact the doc string is commented out on the 27.2 branch, along with the walk-windows implementation. It's unclear to me from the git history why this implementation for all windows was commented out in the first place, but at the very least the doc string should be updated to correctly reflect the current implementation.

Thanks.

Sebastian
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#54288; Package emacs. (Mon, 07 Mar 2022 15:20:02 GMT) Full text and rfc822 format available.

Message #8 received at 54288 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: sebastian <at> bsnrg.net
Cc: 54288 <at> debbugs.gnu.org
Subject: Re: bug#54288: 28.0.91; which-func documentation error
Date: Mon, 07 Mar 2022 16:19:45 +0100

sebastian <at> bsnrg.net writes:

> The doc string is incorrect, since the function only updates the selected window. In fact the doc string is commented out on the 27.2 branch, along with the walk-windows implementation. It's unclear to me from the git history why this implementation for all windows was commented out in the first place, but at the very least the doc string should be updated to correctly reflect the current implementation.

I've now done this in emacs-28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
bug marked as fixed in version 28.1, send any further explanations to 54288 <at> debbugs.gnu.org and sebastian <at> bsnrg.net Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 07 Mar 2022 15:20:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Tue, 05 Apr 2022 11:24:09 GMT) Full text and rfc822 format available.
This bug report was last modified 3 years and 74 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.