threads / patch / 55098

patchdoc/git-branch: fix awkward wording for "-c"

Subject: [PATCH] doc/git-branch: fix awkward wording for "-c"

## tl;dr

3 messages between Feb 3, 2021 and Feb 4, 2021. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Jeff King· Feb 3, 2021, 21:07 UTC · lore

The description for "-c" is hard to parse. I think the big issue is lack of commas, but I've also reordered the words to keep the main focus point of "instead of renaming, copy" together.

Signed-off-by: Jeff King <peff@peff.net>
---
Just happened to be reading this when writing the nearby completion
patch.

 Documentation/git-branch.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/git-branch.txt +2 −2

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index adaa1782a8..eb815c2248 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -78,8 +78,8 @@ renaming. If <newbranch> exists, -M must be used to force the rename
 to happen.
 
 The `-c` and `-C` options have the exact same semantics as `-m` and
-`-M`, except instead of the branch being renamed it along with its
-config and reflog will be copied to a new name.
+`-M`, except instead of the branch being renamed, it will be copied to a
+new name, along with its config and reflog.
 
 With a `-d` or `-D` option, `<branchname>` will be deleted.  You may
 specify more than one branch for deletion.  If the branch currently

-- 
2.30.0.882.gf229bd7cc9

Taylor Blau· Feb 3, 2021, 21:13 UTC · re: Jeff King · lore

Re: [PATCH] doc/git-branch: fix awkward wording for "-c"

On Wed, Feb 03, 2021 at 04:07:32PM -0500, Jeff King wrote:

Show 5 quoted lines

> The description for "-c" is hard to parse. I think the big issue is lack
> of commas, but I've also reordered the words to keep the main focus
> point of "instead of renaming, copy" together.
>
> Signed-off-by: Jeff King <peff@peff.net>

Much clearer, thanks. I'm only responding to acknowledge that it reads more clearly to me, too.

Robert Karszniewicz· Feb 4, 2021, 01:21 UTC · re: Taylor Blau · lore

Re: [PATCH] doc/git-branch: fix awkward wording for "-c"

On Wed, Feb 03, 2021 at 04:13:28PM -0500, Taylor Blau wrote:

Show 9 quoted lines

> On Wed, Feb 03, 2021 at 04:07:32PM -0500, Jeff King wrote:
> > The description for "-c" is hard to parse. I think the big issue is lack
> > of commas, but I've also reordered the words to keep the main focus
> > point of "instead of renaming, copy" together.
> >
> > Signed-off-by: Jeff King <peff@peff.net>
> 
> Much clearer, thanks. I'm only responding to acknowledge that it reads
> more clearly to me, too.

I second that, much better. Thanks.