help descriptions for better clarity

- Improved command-line help and help descriptions for better clarity. - Fixed typos in various files.
noborus · Oct 9, 2024 · 40e74e2 · 40e74e2
1 parent ea9fda2
commit 40e74e2
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/main.go b/main.go
@@ -370,8 +370,8 @@ func init() {
 	rootCmd.PersistentFlags().StringVarP(&nonMatchFilter, "non-match-filter", "", "", "filter non match search pattern")
 	rootCmd.PersistentFlags().BoolVarP(&oviewer.SkipExtract, "skip-extract", "", false, "skip extracting compressed files")
 
-	rootCmd.PersistentFlags().BoolVarP(&alignF, "align", "l", false, "align column")
-	rootCmd.PersistentFlags().BoolVarP(&rawF, "raw", "r", false, "raw output of escape sequences")
+	rootCmd.PersistentFlags().BoolVarP(&alignF, "align", "l", false, "align the output columns for better readability")
+	rootCmd.PersistentFlags().BoolVarP(&rawF, "raw", "r", false, "raw escape sequences without processing")
 
 	// Config.General
 	rootCmd.PersistentFlags().StringP("converter", "", "es", "converter [es|raw|align]")

diff --git a/oviewer/content.go b/oviewer/content.go
@@ -36,7 +36,7 @@ var SpaceContent = content{
 	style: tcell.StyleDefault,
 }
 
-// ShrinkContent is a content that represents a shrinked column.
+// ShrinkContent is a content that represents a shrunk column.
 var ShrinkContent = content{
 	mainc: Shrink,
 	combc: nil,

diff --git a/oviewer/convert_es_test.go b/oviewer/convert_es_test.go
@@ -254,7 +254,7 @@ func Test_parseCSI(t *testing.T) {
 			},
 		},
 		{
-			name: "test-atributesNone",
+			name: "test-attributesNone",
 			args: args{
 				params: "28",
 			},

diff --git a/oviewer/input_search_test.go b/oviewer/input_search_test.go
@@ -278,14 +278,14 @@ func Test_stripBackSlash(t *testing.T) {
 		want string
 	}{
 		{
-			name: "nonEsacpe",
+			name: "nonEsacape",
 			args: args{
 				str: "\test",
 			},
 			want: "\test",
 		},
 		{
-			name: "nonEsacpe2",
+			name: "nonEsacape2",
 			args: args{
 				str: "!test",
 			},

diff --git a/oviewer/keybind.go b/oviewer/keybind.go
@@ -353,8 +353,8 @@ func (k KeyBind) String() string {
 	k.writeKeyBind(&b, actionTabWidth, "TAB width")
 	k.writeKeyBind(&b, actionMultiColor, "multi color highlight")
 	k.writeKeyBind(&b, actionJumpTarget, "jump target(`.n` or `n%` or `section` allowed)")
-	k.writeKeyBind(&b, actionAlignFormat, "align format")
-	k.writeKeyBind(&b, actionRawFormat, "raw format")
+	k.writeKeyBind(&b, actionAlignFormat, "align columns")
+	k.writeKeyBind(&b, actionRawFormat, "raw output")
 	k.writeKeyBind(&b, actionConvertType, "convert type selection")
 
 	writeHeader(&b, "Section")
@@ -365,7 +365,7 @@ func (k KeyBind) String() string {
 	k.writeKeyBind(&b, actionLastSection, "last section")
 	k.writeKeyBind(&b, actionFollowSection, "follow section mode toggle")
 	k.writeKeyBind(&b, actionSectionNum, "number of section header lines")
-	k.writeKeyBind(&b, actionHideOther, "toggle hide other section")
+	k.writeKeyBind(&b, actionHideOther, "hide other section toggle")
 
 	writeHeader(&b, "Close and reload")
 	k.writeKeyBind(&b, actionCloseFile, "close file")

diff --git a/oviewer/mouse_test.go b/oviewer/mouse_test.go
@@ -76,7 +76,7 @@ func TestRoot_mouseEvent(t *testing.T) {
 			want: false,
 		},
 		{
-			name: "testShifWheelUp",
+			name: "testShiftWheelUp",
 			fields: fields{
 				ev: tcell.NewEventMouse(0, 0, tcell.WheelUp, tcell.ModShift),
 			},