bug#39436: 27.0.60; Documentaion error for package-menu-hide-package

[Pieter van Oostrum]

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Wed, 5 Feb 2020 16:10:55 +0100
>> From: Pieter van Oostrum <pieter@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]