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

allejo · allejo · commit 6867c798bcfb · 2021-05-25T01:22:51.000-07:00
diff --git a/Commands.md b/Commands.md
@@ -854,7 +854,7 @@ 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
diff --git a/man/git-delete-squashed-branches.1 b/man/git-delete-squashed-branches.1
@@ -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\.
diff --git a/man/git-delete-squashed-branches.html b/man/git-delete-squashed-branches.html
diff --git a/man/git-delete-squashed-branches.md b/man/git-delete-squashed-branches.md
@@ -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
 

Original file line number	Diff line number	Diff line change
`@@ -7,16 +7,16 @@`
`7`	`7`	`\fBgit\-delete\-squashed\-branches\fR \- Delete branches that were squashed`
`8`	`8`	`.`
`9`	`9`	`.SH "SYNOPSIS"`
`10`		`-\fBgit\-delete\-squashed\-branches\fR [<target\-branch>]`
	`10`	`+\fBgit\-delete\-squashed\-branches\fR [<branch\-name>]`
`11`	`11`	`.`
`12`	`12`	`.SH "DESCRIPTION"`
`13`		`-Deletes all git branches that have been "squash\-merged" into \fBtarget\-branch\fR\.`
	`13`	`+Deletes all git branches that have been "squash\-merged" into \fBbranch\-name\fR\.`
`14`	`14`	`.`
`15`	`15`	`.SH "OPTIONS"`
`16`		`-<target\-branch>`
	`16`	`+<branch\-name>`
`17`	`17`	`.`
`18`	`18`	`.P`
`19`		`-The target branch were the "squashed\-merged" branches were committed to\.`
	`19`	`+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\.`
`20`	`20`	`.`
`21`	`21`	`.SH "EXAMPLES"`
`22`	`22`	`Delete all branches that were "squash\-merged" into the current checked out branch\.`