summaryrefslogtreecommitdiff
path: root/piem.el
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-06-15 00:39:51 -0400
committerKyle Meyer <kyle@kyleam.com>2020-06-15 00:39:51 -0400
commit69955d8d75d3a7ab647d3e883f9c64522ebc3dea (patch)
treebb1359140d5c382cf20e349f9973e3c3411dae13 /piem.el
parent43cb1108e11107afc0220e1773478b7884837987 (diff)
downloadpiem-69955d8d75d3a7ab647d3e883f9c64522ebc3dea.tar.gz
Add docstrings to all -am commands
Diffstat (limited to 'piem.el')
-rw-r--r--piem.el10
1 files changed, 10 insertions, 0 deletions
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