More accurate documentation of 'package-menu-hide-package'
authorEli Zaretskii <eliz@gnu.org>
Sat, 8 Feb 2020 09:38:52 +0000 (11:38 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 8 Feb 2020 09:38:52 +0000 (11:38 +0200)
* doc/emacs/package.texi (Package Menu): Improve the description
of the 'H' command.

* lisp/emacs-lisp/package.el (package-menu-mode-menu): More
accurate wording of the help-echo string.
(package-menu-hide-package): Make the doc string more accurate.
(Bug#39436)

doc/emacs/package.texi
lisp/emacs-lisp/package.el

index 1cac7f9b4b633875c02ac121bcb61dc34cea0ccd..6bf4fc7e10cd3dfffd64b36352b9c57515ac971e 100644 (file)
@@ -175,8 +175,11 @@ Clear filter currently applied to the package list
 @item H
 @kindex H @r{(Package Menu)}
 @findex package-menu-hide-package
-Permanently hide packages that match a regexp
-(@code{package-menu-hide-package}).
+Hide packages whose names match a regexp
+(@code{package-menu-hide-package}).  This prompts for a regexp, and
+then hides the packages with matching names.  The default value of the
+regexp will hide only the package whose name is at point, so just
+pressing @key{RET} to the prompt will hide the current package.
 
 @item (
 @kindex ( @r{(Package Menu)}
index 130b105bb5dfae423fce221817248bf76256e8df..64d2001646f92413be47d75b1ed589b33d88e40b 100644 (file)
@@ -2734,7 +2734,7 @@ either a full name or nil, and EMAIL is a valid email address."
      ["Filter by Name" package-menu-filter-by-name :help "Filter packages by name"]
      ["Clear Filter" package-menu-clear-filter :help "Clear package list filter"])
 
-    ["Hide by Regexp" package-menu-hide-package :help "Permanently hide all packages matching a regexp"]
+    ["Hide by Regexp" package-menu-hide-package :help "Hide all packages matching a regexp"]
     ["Display Older Versions" package-menu-toggle-hiding
      :style toggle :selected (not package-menu--hide-packages)
      :help "Display package even if a newer version is already installed"]
@@ -3187,8 +3187,9 @@ function.  The args ARG and NOCONFIRM, passed from
 (define-obsolete-function-alias 'package-menu-refresh 'revert-buffer "27.1")
 
 (defun package-menu-hide-package ()
-  "Hide a package under point in Package Menu.
-If optional arg BUTTON is non-nil, describe its associated 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."
   (interactive)
   (package--ensure-package-menu-mode)
   (declare (interactive-only "change `package-hidden-regexps' instead."))