From aa350ba27599c7496f6edc37ef2470051bd9431b Mon Sep 17 00:00:00 2001 From: Philip Kaludercic Date: Sat, 8 Oct 2022 14:41:53 +0200 Subject: [PATCH] ; Add missing documentation strings * lisp/vc/vc.el (vc-read-revision): Add a docstring. (vc-read-multiple-revisions): Add a docstring. --- lisp/vc/vc.el | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 72189cfcb87..1c64551d068 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -1921,6 +1921,13 @@ Return t if the buffer had changes, nil otherwise." "History for `vc-read-revision'.") (defun vc-read-revision (prompt &optional files backend default initial-input multiple) + "Query the user for a revision using PROMPT. +All subsequent arguments are optional. FILES may specify a file +set to restrict the revisions to. BACKEND is a VC backend as +listed in `vc-handled-backends'. DEFAULT and INITIAL-INPUT are +handled as defined by `completing-read'. If MULTIPLE is non-nil, +the user may be prompted for multiple revisions. If possible +this means that `completing-read-multiple' will be used." (cond ((null files) (let ((vc-fileset (vc-deduce-fileset t))) ;FIXME: why t? --Stef @@ -1942,6 +1949,10 @@ Return t if the buffer had changes, nil otherwise." answer))))) (defun vc-read-multiple-revisions (prompt &optional files backend default initial-input) + "Query the user for multiple revisions. +This is equivalent to invoking `vc-read-revision' with t for +MULTIPLE. The arguments PROMPT, FILES, BACKEND, DEFAULT and +INITIAL-INPUT are passed on to `vc-read-revision' directly." (vc-read-revision prompt files backend default initial-input t)) (defun vc-diff-build-argument-list-internal (&optional fileset) -- 2.39.5