Improve doc string of 'package-delete'
authorNikolaos Chatzikonstantinou <nchatz314@gmail.com>
Sun, 5 Jan 2025 13:16:06 +0000 (08:16 -0500)
committerEli Zaretskii <eliz@gnu.org>
Thu, 9 Jan 2025 07:27:44 +0000 (09:27 +0200)
* lisp/emacs-lisp/package.el (package-delete): Elaborate on the
kind of argument expected by the function.  (Bug#75382)

lisp/emacs-lisp/package.el

index 0fc5aaac3430fda43821b14ae1873491287517ed..be3b85f3179c4a49df395bbe11f2a3730e540f9d 100644 (file)
@@ -2498,8 +2498,9 @@ compiled."
 (defun package-delete (pkg-desc &optional force nosave)
   "Delete package PKG-DESC.
 
-Argument PKG-DESC is a full description of package as vector.
-Interactively, prompt the user for the package name and version.
+Argument PKG-DESC is the full description of the package, for example as
+obtained by `package-get-descriptor'.  Interactively, prompt the user
+for the package name and version.
 
 When package is used elsewhere as dependency of another package,
 refuse deleting it and return an error.