git: Fix Status.IsClean() documentation

urld · urld · commit da56abd1530c · 2018-10-06T22:55:42.000+02:00
The documentation of the IsClean Method contained a negation, so it was describing the opposite of its actual behavior. Fixes #838 Signed-off-by: David Url <david@urld.io>
diff --git a/status.go b/status.go
@@ -26,7 +26,7 @@ func (s Status) IsUntracked(path string) bool {
 	return ok && stat.Worktree == Untracked
 }
 
-// IsClean returns true if all the files aren't in Unmodified status.
+// IsClean returns true if all the files are in Unmodified status.
 func (s Status) IsClean() bool {
 	for _, status := range s {
 		if status.Worktree != Unmodified || status.Staging != Unmodified {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ func (s Status) IsUntracked(path string) bool {`
`26`	`26`	`return ok && stat.Worktree == Untracked`
`27`	`27`	`}`
`28`	`28`
`29`		`-// IsClean returns true if all the files aren't in Unmodified status.`
	`29`	`+// IsClean returns true if all the files are in Unmodified status.`
`30`	`30`	`func (s Status) IsClean() bool {`
`31`	`31`	`for _, status := range s {`
`32`	`32`	`if status.Worktree != Unmodified \|\| status.Staging != Unmodified {`