Add docstrings to all -am commands

2 files changed, 21 insertions, 0 deletions

diff --git a/piem-b4.el b/piem-b4.el
index 60f1368..d1ec157 100644
--- a/piem-b4.el
+++ b/piem-b4.el
@@ -84,6 +84,9 @@
 
 ;;;###autoload
 (defun piem-b4-am-ready-from-mbox (mbox &optional args)
+  "Extract an am-ready mbox from a thread of messages.
+MBOX is the file name of an mbox that contains a patch series.
+ARGS is a list of arguments to pass to `b4 am'."
   (interactive (list (read-file-name "mbox: ")
                      (transient-args 'piem-b4-am)))
   (apply #'piem-process-start nil piem-b4-b4-executable "am"
@@ -91,6 +94,9 @@
 
 ;;;###autoload
 (defun piem-b4-am-ready-from-mid (mid &optional args)
+  "Download the thread for MID and and extract an am-ready mbox.
+MID is a Message-Id to pass directly to `b4 am', along with the
+list of arguments specified via ARGS."
   (interactive (list (read-string "Message ID: " nil nil (piem-mid))
                      (transient-args 'piem-b4-am)))
   (apply #'piem-process-start nil piem-b4-b4-executable "am"
@@ -98,6 +104,11 @@
 
 ;;;###autoload
 (defun piem-b4-am-from-mid (mid &optional args)
+  "Get the thread for MID, extract an am-ready mbox, and apply it.
+Try to get a thread for the Message-Id MID with
+`piem-mid-to-thread-functions', falling back to letting b4
+download it.  After calling `b4 am' with ARGS to prepare an
+am-ready mbox, feed the result to `git am'."
   (interactive (list (or (piem-mid)
                          (read-string "Message ID: "))
                      (transient-args 'piem-b4-am)))
diff --git a/piem.el b/piem.el
index 7df0d97..4451c2e 100644
--- a/piem.el
+++ b/piem.el
@@ -522,6 +522,16 @@ in `piem-default-branch-function'."
 
 ;;;###autoload
 (defun piem-am (mbox &optional info coderepo)
+  "Feed an am-ready mbox to `git am'.
+
+MBOX is a buffer whose contents are an am-ready mbox (obtained
+via `piem-am-ready-mbox' when called interactively).  INFO is a
+plist that with information to help choose a default branch name
+or starting point (see `piem-default-branch-function' for a list
+of possible properties).
+
+If CODEREPO is given, switch to this directory before calling
+`git am'."
   (interactive
    (let ((mbox (or (piem-am-ready-mbox)
                    (user-error