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.

Full log


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




This bug report was last modified 3 years and 75 days ago.

Previous Next


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