From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:403:4ea1::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms12 with LMTPS id OBRgMGr0zGGyVwAAsNZ9tg (envelope-from ); Wed, 29 Dec 2021 23:51:06 +0000 Received: from out0.migadu.com ([2001:41d0:2:267::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id cIlWLWr0zGHBFgAAG6o9tA (envelope-from ); Thu, 30 Dec 2021 00:51:06 +0100 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kyleam.com; s=key1; t=1640821866; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=7k/J8oC6uzr68wTqu8t6lDyRR8j/2pMOCwTC7oem+Rw=; b=Ni6zLQWjnLCQNnx6+wYZ2jGqWiFYFpeS0PCoe8vU6sAdXYtaKStLbKAKmrk0AbHA6Y4+R6 SwlvwDqBRE9FlVFEa0tOi0HSHkSz5eisF7q6qZB268oGSjzyltNPHYzaImhdhlzTQCGM+q f/hhtrV6o4WyIa7xrpUAJ7KbULhjDLcuS05FGJfICM0pbX9rHdMkBjaPa6E78Rasgy4au5 TN94TykcBOXQOaJTs+iNITnGTREfaeMYI13r9iLsD1JM8hmlFU5kvQSnqS6pxPOq9vFZzt SfMVMDhZ4dQGyVHbIRcmiecORRLAxclRrFgEvp5WMv3f0/a8JO2s83UfI+GToQ== From: Kyle Meyer 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 Message-Id: <20211229235036.372313-9-kyle@kyleam.com> In-Reply-To: <20211229235036.372313-1-kyle@kyleam.com> References: <20211229235036.372313-1-kyle@kyleam.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: kyleam.com X-TUID: +PLDTQ3QTfYg 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) ;;;###autoload (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 () ;;;###autoload (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 -- 2.34.0