discussion and development of piem
 help / color / mirror / code / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: piem@inbox.kyleam.com
Subject: [RFC PATCH 08/14] am, b4-am: Rewrite -create docstrings to emphasize branch creation
Date: Wed, 29 Dec 2021 18:50:30 -0500	[thread overview]
Message-ID: <20211229235036.372313-9-kyle@kyleam.com> (raw)
In-Reply-To: <20211229235036.372313-1-kyle@kyleam.com>

The manual does a pretty good job of describing branch creation for
piem-am-create and piem-b4-am-from-mid-create, but the docstrings
don't mention it directly, which will become more confusing once there
are am variants that don't create a new branch.

Modify the summary lines to mention branch creation.
 piem-b4.el | 2 +-
 piem.el    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/piem-b4.el b/piem-b4.el
index d29527d9..01004c4b 100644
--- a/piem-b4.el
+++ b/piem-b4.el
@@ -129,7 +129,7 @@ (defun piem-b4-am-ready-from-mid (mid &optional args)
 (defun piem-b4-am-from-mid-create (mid &optional args toggle-worktree)
-  "Get the thread for MID, extract an am-ready mbox, and apply it.
+  "Create a new branch with patches extracted from MID's thread.
 Try to generate a thread for the Message-Id MID with
 `piem-mid-to-thread-functions'.  If that fails, try to download
diff --git a/piem.el b/piem.el
index 1a3725cc..1c00cab8 100644
--- a/piem.el
+++ b/piem.el
@@ -955,7 +955,7 @@ (defun piem-am--arguments ()
 (defun piem-am-create (mbox &optional format info coderepo toggle-worktree)
-  "Feed an am-ready mbox to `git am'.
+  "Create a new branch by feeding 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).  FORMAT

  parent reply	other threads:[~2021-12-29 23:51 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-29 23:50 [RFC PATCH 00/14] am, b4-am: Add commands to extend an existing branch Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 01/14] am: Give better name to default piem-am-read-worktree-function value Kyle Meyer
2022-02-05 17:37   ` Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 02/14] am: Add dedicated function for reading worktree Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 03/14] am: Extract git-am logic to dedicated function Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 04/14] am: Add function for reading piem-am's arguments Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 05/14] am: Add comment header for patch editing subsection Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 06/14] edit patch: Inject values via interactive arguments Kyle Meyer
2022-02-05 17:48   ` Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 07/14] am, b4-am: Rename piem-am to piem-am-create Kyle Meyer
2021-12-29 23:50 ` Kyle Meyer [this message]
2021-12-29 23:50 ` [RFC PATCH 09/14] piem-am-create: Move info argument to the end Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 10/14] piem-am--arguments: Make info extraction optional Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 11/14] b4: Move logic for checking arguments to a dedicated function Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 12/14] am, b4-am: Add commands that extend an existing branch Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 13/14] am: Move functionality under a dedicated transient Kyle Meyer
2021-12-29 23:50 ` [RFC PATCH 14/14] b4: Add piem-b4-am-from-mid-extend to transient Kyle Meyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: https://git.kyleam.com/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211229235036.372313-9-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=piem@inbox.kyleam.com \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).