scratch/package-vc-fixes 6ba14d437b 10/14: Expand 'package-vc--unpack-1' documentation

[Philip Kaludercic]

branch: scratch/package-vc-fixes
commit 6ba14d437bdba4318d60029ecd5d597533395f7e
Author: Philip Kaludercic <philipk@posteo.net>
Commit: Philip Kaludercic <philipk@posteo.net>

    Expand 'package-vc--unpack-1' documentation
    
    * lisp/emacs-lisp/package-vc.el (package-vc--unpack-1): Explain what
    the function does.
---
 lisp/emacs-lisp/package-vc.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el
index 23ac0a88c5..10b9e9b309 100644
--- a/lisp/emacs-lisp/package-vc.el
+++ b/lisp/emacs-lisp/package-vc.el
@@ -371,7 +371,11 @@ otherwise it's assumed to be an Info file."
                   file pkg-dir)))
 
 (defun package-vc--unpack-1 (pkg-desc pkg-dir)
-  "Install PKG-DESC that is already checked-out in PKG-DIR."
+  "Prepare PKG-DESC that is already checked-out in PKG-DIR.
+This includes downloading missing dependencies, generating
+autoloads, generating a package description file (used to
+identify a package as a source package later on), building
+documentation and marking the package as installed."
   ;; In case the package was installed directly from source, the
   ;; dependency list wasn't know beforehand, and they might have
   ;; to be installed explicitly.