]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify 'package-vc--build-documentation' docstring
authorPhilip Kaludercic <philipk@posteo.net>
Sun, 6 Nov 2022 11:12:23 +0000 (12:12 +0100)
committerPhilip Kaludercic <philipk@posteo.net>
Thu, 17 Nov 2022 19:37:28 +0000 (20:37 +0100)
* lisp/emacs-lisp/package-vc.el (package-vc--build-documentation):
Rewrite the first line.

As suggested by Eli Zaretskii.

lisp/emacs-lisp/package-vc.el

index 9288faf380fe1cb2d4c8790b8aef7d325985c7eb..e1a84c466e3647af0cbb4768bc27fcd6eed386b3 100644 (file)
@@ -360,7 +360,7 @@ asynchronously."
 (declare-function org-export-to-file "ox" (backend file))
 
 (defun package-vc--build-documentation (pkg-desc file)
-  "Build documentation FILE for PKG-DESC.
+  "Build documentation for package PKG-DESC from documentation source in FILE.
 FILE can be an Org file, indicated by its \".org\" extension,
 otherwise it's assumed to be an Info file."
   (let ((pkg-dir (package-desc-dir pkg-desc)))