From: Philip Kaludercic <philipk@posteo.net>
Date: Sun, 6 Nov 2022 11:12:23 +0000 (+0100)
Subject: Clarify 'package-vc--build-documentation' docstring
X-Git-Tag: emacs-29.0.90~1616^2~90
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f939859fe4eab6774f41030b27f5329afd4e98b1;p=emacs.git

Clarify 'package-vc--build-documentation' docstring

* lisp/emacs-lisp/package-vc.el (package-vc--build-documentation):
Rewrite the first line.

As suggested by Eli Zaretskii.
---

diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el
index 9288faf380f..e1a84c466e3 100644
--- a/lisp/emacs-lisp/package-vc.el
+++ b/lisp/emacs-lisp/package-vc.el
@@ -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)))