diff options
| author | Radon Rosborough <radon.neon@gmail.com> | 2017-03-08 18:16:31 -0800 |
|---|---|---|
| committer | Radon Rosborough <radon.neon@gmail.com> | 2017-03-08 18:17:49 -0800 |
| commit | a233f01ff64a3cb4002c3913883035bb1b299208 (patch) | |
| tree | 7b057a4bc39378ce5b3375f10c54604119812fd9 /lisp/use-package/use-package.el | |
| parent | 4e6115214b24b5e52fddcb53040045890d01f59a (diff) | |
| download | emacs-a233f01ff64a3cb4002c3913883035bb1b299208.tar.gz emacs-a233f01ff64a3cb4002c3913883035bb1b299208.tar.bz2 emacs-a233f01ff64a3cb4002c3913883035bb1b299208.zip | |
Update docstring for use-package-ensure-function
Now it properly reflects the API changes recently made.
Diffstat (limited to 'lisp/use-package/use-package.el')
| -rw-r--r-- | lisp/use-package/use-package.el | 8 |
1 files 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) |