docs: improve code documentation and formatting consistency

- Add a comment describing the `availableKeys` map
- Correct capitalization and formatting of configuration key descriptions

Signed-off-by: Bo-Yi Wu <[email protected]>

Author: appleboy

cmd/config_list.go

@@ -14,29 +14,30 @@ func init() {
 }
 
 // availableKeys is a list of available config keys
+// availableKeys is a map of configuration keys and their descriptions
 var availableKeys = map[string]string{
-	"git.diff_unified":         "generate diffs with <n> lines of context, default is 3",
-	"git.exclude_list":         "exclude file from git diff command",
-	"git.template_file":        "template file for commit message",
-	"git.template_string":      "template string for commit message",
-	"openai.socks":             "socks proxy",
-	"openai.api_key":           "openai api key",
-	"openai.model":             "openai model",
-	"openai.org_id":            "openai requesting organization",
-	"openai.proxy":             "http proxy",
-	"output.lang":              "summarizing language uses English by default",
-	"openai.base_url":          "what API base url to use.",
-	"openai.timeout":           "request timeout",
-	"openai.max_tokens":        "the maximum number of tokens to generate in the chat completion.",
-	"openai.temperature":       "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.",
-	"openai.provider":          "service provider, only support 'openai' or 'azure'",
-	"openai.skip_verify":       "skip verify TLS certificate",
-	"openai.headers":           "custom headers for openai request",
-	"openai.api_version":       "openai api version",
-	"openai.top_p":             "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.",
-	"openai.frequency_penalty": "Number between 0.0 and 1.0 that penalizes new tokens based on their existing frequency in the text so far. Decreases the model's likelihood to repeat the same line verbatim.",
-	"openai.presence_penalty":  "Number between 0.0 and 1.0 that penalizes new tokens based on whether they appear in the text so far. Increases the model's likelihood to talk about new topics.",
-	"prompt.folder":            "prompt template folder",
+	"git.diff_unified":         "Generate diffs with <n> lines of context, default is 3",
+	"git.exclude_list":         "Exclude file from git diff command",
+	"git.template_file":        "Template file for commit message",
+	"git.template_string":      "Template string for commit message",
+	"openai.socks":             "SOCKS proxy",
+	"openai.api_key":           "OpenAI API key",
+	"openai.model":             "OpenAI model",
+	"openai.org_id":            "OpenAI requesting organization",
+	"openai.proxy":             "HTTP proxy",
+	"output.lang":              "Summarizing language, defaults to English",
+	"openai.base_url":          "API base URL to use",
+	"openai.timeout":           "Request timeout",
+	"openai.max_tokens":        "Maximum number of tokens to generate in the chat completion",
+	"openai.temperature":       "Sampling temperature to use, between 0 and 2. Higher values like 0.8 make the output more random, while lower values like 0.2 make it more focused and deterministic",
+	"openai.provider":          "Service provider, supports 'openai' or 'azure'",
+	"openai.skip_verify":       "Skip verifying TLS certificate",
+	"openai.headers":           "Custom headers for OpenAI request",
+	"openai.api_version":       "OpenAI API version",
+	"openai.top_p":             "Nucleus sampling probability mass. For example, 0.1 means only the tokens comprising the top 10% probability mass are considered",
+	"openai.frequency_penalty": "Penalty for new tokens based on their existing frequency in the text so far. Decreases the model's likelihood to repeat the same line verbatim",
+	"openai.presence_penalty":  "Penalty for new tokens based on whether they appear in the text so far. Increases the model's likelihood to talk about new topics",
+	"prompt.folder":            "Prompt template folder",
 }
 
 // configListCmd represents the command to list the configuration values.