GNU bug report logs - #39436
27.0.60; Documentation error for package-menu-hide-package

Previous Next

Full log

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: pieter <at> vanoostrum.org, 39436 <at> debbugs.gnu.org
Subject: Re: bug#39436: closed (Re: bug#39436: 27.0.60;
 Documentaion error for package-menu-hide-package)
Date: Wed, 11 Mar 2020 03:07:48 +0100

[Message part 1 (text/plain, inline)]

Eli Zaretskii <eliz <at> gnu.org> writes:

>> > I've removed "Permanently" and made the description more detailed.
>> 
>> Thanks.  But in the new text, there seems to be no indication that the
>> hidden status is saved for future sessions.
>> 
>> I'm not sure how to best describe that, if we feel that "permanently"
>> is not clear enough.  Maybe we could say something along the lines of
>> "for all future sessions" or somesuch.  It's probably also a good idea
>> to mention the variable package-hidden-regexps.
>> 
>> WDYT?
>
> Feel free to make such a change, although I don't particularly see why
> we need to emphasize the "future sessions" part here.  We don't
> actually say anywhere anything to the contrary, and there are no other
> commands that hide stuff only temporarily, do we?

Well, the filter commands in the package menu only work in the current
buffer.  If you close the buffer and open it again, the filters are
gone.  That is, to my mind, temporary.

In this case, the filter is saved using customize-save-variable and
will therefore be there even if you restart Emacs.  So I think it can
be a bit surprising if it's not documented.

I would suggest the attached patch.

Best regards,
Stefan Kangas

[0001-Clarify-package-menu-hide-package-docstring.patch (text/x-diff, inline)]

From a0250312753fa4a31e1861561570d56c6843aa39 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas <at> gmail.com>
Date: Wed, 11 Mar 2020 03:05:12 +0100
Subject: [PATCH] Clarify package-menu-hide-package docstring

* lisp/emacs-lisp/package.el (package-menu-hide-package): Clarify in
docstring that hiding is saved in a user option.  (Bug#39436)
---
 lisp/emacs-lisp/package.el | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index 43eb038a86..7dbb99684f 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -3190,8 +3190,11 @@ 'package-menu-refresh
 
 (defun package-menu-hide-package ()
   "Hide in Package Menu packages that match a regexp.
-Prompts for the regexp to match against package names.
-The default regexp will hide only the package whose name is at point."
+Prompt for the regexp to match against package names.
+The default regexp will hide only the package whose name is at point.
+
+The regexp is saved for future Emacs sessions in the user option
+`package-hidden-regexps'."
   (interactive)
   (package--ensure-package-menu-mode)
   (declare (interactive-only "change `package-hidden-regexps' instead."))
-- 
2.25.1

Previous Next

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