branch: externals/agitate
commit 52c9968e5fbf00f8a2edf7b05f1d243c796682d4
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Refine agitate-vc-git-push doc string
---
agitate.el | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/agitate.el b/agitate.el
index 50cb062b90..9116b7bc2c 100644
--- a/agitate.el
+++ b/agitate.el
@@ -209,7 +209,12 @@ file extension. Else omit it."
;;;###autoload
(defun agitate-vc-git-push (prompt)
- "Substitute for `vc-git-push' with the same meaning for PROMPT."
+ "Behave like `vc-git-push' but prompt for a remote, if needed.
+The meaning of PROMPT is the same as that of `vc-git-push'. In
+such a case, do not prompt for a remote.
+
+To use this function add it as an override advice to
+`vc-git-push'."
(vc-git--pushpull "push" prompt (unless prompt
`(,(agitate--vc-git-prompt-remote)))))
;;;###autoload
