delete-squashed-branches: Make side-effect clear in docs

This commit is contained in:
Vladimir Jimenez 2021-05-25 01:22:51 -07:00
parent fb1e5db6d7
commit bebcbd11ca
No known key found for this signature in database
GPG key ID: F2846589DCF1211D
4 changed files with 13 additions and 12 deletions

View file

@ -854,12 +854,13 @@ Deleted feature/dashboard (was 923befa).
## git delete-squashed-branches
Deletes branches that have been "squashed-merged" into a specified branch
Deletes branches that have been "squashed-merged" into a specified branch; this branch will be checked out as a side-effect. If no branch is specified, then it will default to the current checked out branch.
```bash
$ git delete-squashed-branches main
$ (feature-branch) git delete-squashed-branches main
Deleted branch dependabot/bundler/kramdown-2.3.1 (was 1d3fb00).
Deleted branch dependabot/bundler/rexml-3.2.5 (was a7e4052).
$ (main) git ...
```
## git fresh-branch

View file

@ -7,16 +7,16 @@
\fBgit\-delete\-squashed\-branches\fR \- Delete branches that were squashed
.
.SH "SYNOPSIS"
\fBgit\-delete\-squashed\-branches\fR [<target\-branch>]
\fBgit\-delete\-squashed\-branches\fR [<branch\-name>]
.
.SH "DESCRIPTION"
Deletes all git branches that have been "squash\-merged" into \fBtarget\-branch\fR\.
Deletes all git branches that have been "squash\-merged" into \fBbranch\-name\fR\.
.
.SH "OPTIONS"
<target\-branch>
<branch\-name>
.
.P
The target branch were the "squashed\-merged" branches were committed to\.
The target branch were the "squashed\-merged" branches were committed to\. If no value is given, then the current checked out branch will be used\.
.
.SH "EXAMPLES"
Delete all branches that were "squash\-merged" into the current checked out branch\.

View file

@ -76,17 +76,17 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-delete-squashed-branches</code> [&lt;target-branch&gt;]</p>
<p><code>git-delete-squashed-branches</code> [&lt;branch-name&gt;]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Deletes all git branches that have been "squash-merged" into <code>target-branch</code>.</p>
<p>Deletes all git branches that have been "squash-merged" into <code>branch-name</code>.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p> &lt;target-branch&gt;</p>
<p> &lt;branch-name&gt;</p>
<p> The target branch were the "squashed-merged" branches were committed to.</p>
<p> The target branch were the "squashed-merged" branches were committed to. If no value is given, then the current checked out branch will be used.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
@ -102,7 +102,7 @@
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Teddy Katz &lt;<a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#111;&#x3a;&#116;&#101;&#100;&#x64;&#121;&#46;&#107;&#x61;&#x74;&#x7a;&#64;&#x67;&#109;&#97;&#105;&#x6c;&#x2e;&#x63;&#111;&#109;" data-bare-link="true">&#x74;&#x65;&#100;&#x64;&#121;&#46;&#107;&#x61;&#x74;&#122;&#64;&#103;&#x6d;&#97;&#x69;&#x6c;&#x2e;&#x63;&#111;&#109;</a>&gt; and Vladimir Jimenez &lt;<a href="&#109;&#97;&#x69;&#108;&#x74;&#111;&#58;&#109;&#x65;&#64;&#x61;&#108;&#x6c;&#x65;&#106;&#x6f;&#x2e;&#105;&#111;" data-bare-link="true">&#x6d;&#101;&#64;&#x61;&#x6c;&#x6c;&#101;&#x6a;&#111;&#x2e;&#x69;&#111;</a>&gt;</p>
<p>Written by Teddy Katz &lt;<a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#58;&#116;&#x65;&#x64;&#x64;&#121;&#46;&#x6b;&#97;&#116;&#122;&#64;&#103;&#109;&#x61;&#105;&#108;&#46;&#99;&#x6f;&#x6d;" data-bare-link="true">&#x74;&#101;&#x64;&#100;&#x79;&#46;&#x6b;&#x61;&#x74;&#x7a;&#x40;&#x67;&#109;&#97;&#105;&#108;&#46;&#x63;&#111;&#109;</a>&gt; and Vladimir Jimenez &lt;<a href="&#x6d;&#97;&#x69;&#108;&#116;&#x6f;&#58;&#109;&#x65;&#x40;&#97;&#108;&#x6c;&#x65;&#x6a;&#111;&#x2e;&#105;&#x6f;" data-bare-link="true">&#109;&#x65;&#64;&#x61;&#x6c;&#108;&#x65;&#106;&#x6f;&#46;&#105;&#x6f;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -13,7 +13,7 @@ Deletes all git branches that have been "squash-merged" into `branch-name`.
&lt;branch-name&gt;
The target branch were the "squashed-merged" branches were committed to.
The target branch were the "squashed-merged" branches were committed to. If no value is given, then the current checked out branch will be used.
## EXAMPLES