minor cleanups

Michael Muré created

Change summary

.gitignore                     | 1 +
bug/op_edit_comment.go         | 2 +-
bug/op_label_change.go         | 2 +-
bug/op_noop.go                 | 2 +-
bug/op_set_metadata.go         | 2 +-
bug/op_set_status.go           | 2 +-
bug/op_set_title.go            | 2 +-
doc/man/git-bug-comment-edit.1 | 2 +-
doc/md/git-bug_comment_edit.md | 2 +-
entity/err.go                  | 2 +-
10 files changed, 10 insertions(+), 9 deletions(-)

Detailed changes

.gitignore 🔗

@@ -7,3 +7,4 @@ git-bug
 dist
 coverage.txt
 .idea/
+.git_bak*

bug/op_edit_comment.go 🔗

@@ -96,7 +96,7 @@ func (op *EditCommentOperation) Validate() error {
 	return nil
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *EditCommentOperation) UnmarshalJSON(data []byte) error {

bug/op_label_change.go 🔗

@@ -95,7 +95,7 @@ func (op *LabelChangeOperation) Validate() error {
 	return nil
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *LabelChangeOperation) UnmarshalJSON(data []byte) error {

bug/op_noop.go 🔗

@@ -31,7 +31,7 @@ func (op *NoOpOperation) Validate() error {
 	return op.OpBase.Validate(op, NoOpOp)
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *NoOpOperation) UnmarshalJSON(data []byte) error {

bug/op_set_metadata.go 🔗

@@ -49,7 +49,7 @@ func (op *SetMetadataOperation) Validate() error {
 	return nil
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *SetMetadataOperation) UnmarshalJSON(data []byte) error {

bug/op_set_status.go 🔗

@@ -51,7 +51,7 @@ func (op *SetStatusOperation) Validate() error {
 	return nil
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *SetStatusOperation) UnmarshalJSON(data []byte) error {

bug/op_set_title.go 🔗

@@ -71,7 +71,7 @@ func (op *SetTitleOperation) Validate() error {
 	return nil
 }
 
-// UnmarshalJSON is a two step JSON unmarshaling
+// UnmarshalJSON is a two step JSON unmarshalling
 // This workaround is necessary to avoid the inner OpBase.MarshalJSON
 // overriding the outer op's MarshalJSON
 func (op *SetTitleOperation) UnmarshalJSON(data []byte) error {

doc/man/git-bug-comment-edit.1 🔗

@@ -8,7 +8,7 @@ git\-bug\-comment\-edit \- Edit an existing comment on a bug.
 
 .SH SYNOPSIS
 .PP
-\fBgit\-bug comment edit  [flags]\fP
+\fBgit\-bug comment edit [COMMENT\_ID] [flags]\fP
 
 
 .SH DESCRIPTION

doc/md/git-bug_comment_edit.md 🔗

@@ -3,7 +3,7 @@
 Edit an existing comment on a bug.
 
 ```
-git-bug comment edit <commentid> [flags]
+git-bug comment edit [COMMENT_ID] [flags]
 ```
 
 ### Options

entity/err.go 🔗

@@ -52,7 +52,7 @@ func NewErrUnknowFormat(expected uint) *ErrInvalidFormat {
 
 func (e ErrInvalidFormat) Error() string {
 	if e.version == 0 {
-		return fmt.Sprintf("unreadable data, expected format version %v", e.expected)
+		return fmt.Sprintf("unreadable data, you likely have an outdated repository format, please use https://github.com/MichaelMure/git-bug-migration to upgrade to format version %v", e.expected)
 	}
 	if e.version < e.expected {
 		return fmt.Sprintf("outdated repository format %v, please use https://github.com/MichaelMure/git-bug-migration to upgrade to format version %v", e.version, e.expected)