From a233f01ff64a3cb4002c3913883035bb1b299208 Mon Sep 17 00:00:00 2001 From: Radon Rosborough Date: Wed, 8 Mar 2017 18:16:31 -0800 Subject: [PATCH] Update docstring for use-package-ensure-function Now it properly reflects the API changes recently made. --- lisp/use-package/use-package.el | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lisp/use-package/use-package.el b/lisp/use-package/use-package.el index 2ef697201f8..13ba63446c1 100644 --- a/lisp/use-package/use-package.el +++ b/lisp/use-package/use-package.el @@ -184,8 +184,12 @@ Must be set before loading use-package." (defcustom use-package-ensure-function 'use-package-ensure-elpa "Function that ensures a package is installed. -This function is called with one argument, the package name as a -symbol, by the `:ensure' keyword. +This function is called with three arguments: the name of the +package declared in the `use-package' form; the argument passed +to `:ensure'; and the current `state' plist created by previous +handlers. Note that this function is called whenever `:ensure' is +provided, even if it is nil. It is up to the function to decide +on the semantics of the various values for `:ensure'. The default value uses package.el to install the package." :type '(choice (const :tag "package.el" use-package-ensure-elpa) -- 2.39.2