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

Previous Next

Package: emacs;

Reported by: Pieter van Oostrum <pieter <at> vanoostrum.org>

Date: Wed, 5 Feb 2020 15:12:01 UTC

Severity: normal

Found in version 27.0.60

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

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Pieter van Oostrum <pieter-l <at> vanoostrum.org>
To: 39436 <at> debbugs.gnu.org
Cc: eliz <at> gnu.org, pieter <at> vanoostrum.org
Subject: bug#39436: 27.0.60; Documentaion error for package-menu-hide-package
Date: Sat, 08 Feb 2020 14:58:27 +0100
Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Wed, 5 Feb 2020 16:10:55 +0100
>> From: Pieter van Oostrum <pieter <at> vanoostrum.org>
>> 
>> The documentation (C-h f) for package-menu-hide-package says:
>> 
>> """
>> Hide a package under point in Package Menu.
>> If optional arg BUTTON is non-nil, describe its associated package.
>> """
>> 
>> This is incorrect. (1) There is no optional arg BUTTON.
>> (2) It doesn't hide package under point. Instead it asks for a regpexp
>> (defaulting to the name of the package under point), and hides packages
>> that match the regexp.
>
> Fixed.
>
>> This is also the description in the Emacs info file:
>> 
>> """
>> 
>> ‘H’
>>      Permanently hide packages that match a regexp
>>      (‘package-menu-hide-package’).
>> """
>> (although "permanently" sounds quite strong to me.)
>
> I've removed "Permanently" and made the description more detailed.

This part isn't correct.

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.

It will hide every package whose name STARTS WITH the name of the
current package The default regexp is \`<name>; for the description to
be correct it should be \`<name>\'. In fact I think this would be a
better default, but it would be an incompatible change (but not very
serious). Given the wrong previous documentation, it might even have
been the original intention.
-- 
Pieter van Oostrum
www: http://pieter.vanoostrum.org/
PGP key: [8DAE142BE17999C4]




This bug report was last modified 5 years and 133 days ago.

Previous Next


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