bug#39861: master; Documentation of package-menu--generate incomplete

bug#39861: master; Documentation of package-menu--generate incomplete

[Pieter van Oostrum]

In the master branch, the documentation string of `package-menu--generate' is missing the description of the `remember-pos' parameter. 
Originally it contained:

If REMEMBER-POS is non-nil, keep point on the same entry.

but this line disappeared in commit aea12d4903.
-- 
Pieter van Oostrum <pieter@vanoostrum.org>
www: http://pieter.vanoostrum.org/
PGP key: [8DAE142BE17999C4]

bug#39861: master; Documentation of package-menu--generate incomplete

[Pieter van Oostrum]

[-- Attachment #1: Type: text/plain, Size: 353 bytes --]

Pieter van Oostrum <pieter@vanoostrum.org> writes:

> In the master branch, the documentation string of
> `package-menu--generate' is missing the description of the
> `remember-pos' parameter.
> Originally it contained:
>
> If REMEMBER-POS is non-nil, keep point on the same entry.
>
> but this line disappeared in commit aea12d4903.

Here is a patch:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-emacs-lisp-package.el-package-menu-generate-Fix.patch --]
[-- Type: text/x-patch, Size: 881 bytes --]

From 8bbb779bfa70f91641d7ebd508bd1506452f65b7 Mon Sep 17 00:00:00 2001
From: Pieter van Oostrum <pieter@vanoostrum.org>
Date: Tue, 3 Mar 2020 16:27:21 +0100
Subject: [PATCH] * lisp/emacs-lisp/package.el (package-menu--generate): Fix
 docstring

Add REMEMBER-POS to docstring (bug#39861)
---
 lisp/emacs-lisp/package.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index 43eb038a86..6d6b31f1f3 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -3042,6 +3042,7 @@ package-menu--display
 
 (defun package-menu--generate (remember-pos &optional packages keywords)
   "Populate and display the Package Menu.
+If REMEMBER-POS is non-nil, keep point on the same entry.
 PACKAGES should be t, which means to display all known packages,
 or a list of package names (symbols) to display.
 
-- 
2.25.1


[-- Attachment #3: Type: text/plain, Size: 87 bytes --]


-- 
Pieter van Oostrum
www: http://pieter.vanoostrum.org/
PGP key: [8DAE142BE17999C4]

bug#39861: master; Documentation of package-menu--generate incomplete

[Eli Zaretskii]

> From: Pieter van Oostrum <pieter-l@vanoostrum.org>
> Date: Tue, 03 Mar 2020 16:30:10 +0100
> Cc: 39861@debbugs.gnu.org
> 
> > In the master branch, the documentation string of
> > `package-menu--generate' is missing the description of the
> > `remember-pos' parameter.
> > Originally it contained:
> >
> > If REMEMBER-POS is non-nil, keep point on the same entry.
> >
> > but this line disappeared in commit aea12d4903.
> 
> Here is a patch:

Thanks, pushed.

Please in the future always end sentences with a period (I fixed this
case for you).  The header line of a commit message doesn't have to
have a period (although in this case it should), but the subsequent
line do.

bug#39861: Close bug#39861: master; Documentation of package-menu--generate incomplete

[Pieter van Oostrum]