Docs

Author: jotaen

klog/app/cli/config.go

@@ -1,11 +1,12 @@
 package cli
 
 import (
+	"path/filepath"
+	"strings"
+
 	"github.com/jotaen/klog/klog/app"
 	tf "github.com/jotaen/klog/klog/app/cli/terminalformat"
 	"github.com/jotaen/klog/klog/app/cli/util"
-	"path/filepath"
-	"strings"
 )
 
 type Config struct {
@@ -27,7 +28,7 @@ klog relies on file-based configuration to customise some of its default behavio
 
 Run 'klog config --location' to print the path of the folder where klog looks for the configuration.
 The config folder can contain one or both of the following files:
-  - '` + app.CONFIG_FILE_NAME + `': you can create this file manually to override some of klog’s default behaviour. You may use the output of the 'klog config' command as template for setting up this file, as its output is in valid syntax. 
+  - '` + app.CONFIG_FILE_NAME + `': you can create this file manually to override some of klog’s default behaviour. You may use the output of the 'klog config' command as template for setting up this file, as its output is valid .ini syntax. 
   - '` + app.BOOKMARKS_FILE_NAME + `': if you use the bookmarks functionality, then klog uses this file as database. You are not supposed to edit this file by hand! Instead, use the 'klog bookmarks' command to manage your bookmarks.
 
 You can customise the location of the config folder via environment variables. klog uses the following lookup precedence:

klog/app/config.go

@@ -238,8 +238,8 @@ var CONFIG_FILE_ENTRIES = []ConfigFileEntries[any]{
 	}, {
 		Name: "no_warnings",
 		Help: Help{
-			Summary: "Whether klog should suppress warnings when processing files.",
-			Value:   "The config property must be one of: `UNCLOSED_OPEN_RANGE` (for unclosed open ranges in past records), `FUTURE_ENTRIES` (for records/entries in the future), `OVERLAPPING_RANGES` (for time ranges that overlap), `MORE_THAN_24H` (if there is a record with more than 24h total). Multiple values must be separated by a comma, e.g.: `UNCLOSED_OPEN_RANGE, MORE_THAN_24H`.",
+			Summary: "Whether klog should suppress certain warnings when processing files.",
+			Value:   "The config property must be one (or several comma-separated) of: `UNCLOSED_OPEN_RANGE` (for unclosed open ranges in past records), `FUTURE_ENTRIES` (for records/entries in the future), `OVERLAPPING_RANGES` (for time ranges that overlap), `MORE_THAN_24H` (if there is a record with more than 24h total). Multiple values must be separated by a comma, e.g.: `UNCLOSED_OPEN_RANGE, MORE_THAN_24H`.",
 			Default: "If absent/empty, klog prints all available warnings.",
 		},
 		read: func(value string, config *Config) error {