fix: documentation for BreakingMessage() method.

zbindenren · Jan 4, 2021 · 9cd0522 · 9cd0522
1 parent c186f94
commit 9cd0522
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/parse.go b/parse.go
@@ -48,9 +48,8 @@ type Footer struct {
 type Footers []Footer
 
 // BreakingMessage returns the breaking change message text. If the breaking change
-// is indicated with `!` only, the description is returned. If a `BREAKING CHANGE`
-// or `BREAKING_CHANGE` footer token is detected, the corresponding footer value
-// is returned.
+// is indicated with a `BREAKING CHANGE` or `BREAKING_CHANGE` footer token, then this
+// value is returned. Otherwise the header description is returned.
 //
 // If no breaking change is detected an empty string is returned.
 func (c Commit) BreakingMessage() string {