Skip to content

Commit 0c9154c

Browse files
committed
Add comments with more information
This will be useful in the next commit when these start to show up in the generated Config.md.
1 parent a51bf12 commit 0c9154c

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

pkg/config/user_config.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ type UserConfig struct {
2424
// If true, don't display introductory popups upon opening Lazygit.
2525
DisableStartupPopups bool `yaml:"disableStartupPopups"`
2626
// User-configured commands that can be invoked from within Lazygit
27+
// See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md
2728
CustomCommands []CustomCommand `yaml:"customCommands" jsonschema:"uniqueItems=true"`
2829
// See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls
2930
Services map[string]string `yaml:"services"`
@@ -252,7 +253,7 @@ type GitConfig struct {
252253
// Command used to display git log of all branches in the main window.
253254
// Deprecated: Use `allBranchesLogCmds` instead.
254255
AllBranchesLogCmd string `yaml:"allBranchesLogCmd"`
255-
// Commands used to display git log of all branches in the main window, they will be cycled in order of appearance
256+
// Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
256257
AllBranchesLogCmds []string `yaml:"allBranchesLogCmds"`
257258
// If true, do not spawn a separate process when using GPG
258259
OverrideGpg bool `yaml:"overrideGpg"`

schema/config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@
329329
"type": "string"
330330
},
331331
"type": "array",
332-
"description": "Commands used to display git log of all branches in the main window, they will be cycled in order of appearance"
332+
"description": "Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)"
333333
},
334334
"overrideGpg": {
335335
"type": "boolean",
@@ -1838,7 +1838,7 @@
18381838
},
18391839
"type": "array",
18401840
"uniqueItems": true,
1841-
"description": "User-configured commands that can be invoked from within Lazygit"
1841+
"description": "User-configured commands that can be invoked from within Lazygit\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md"
18421842
},
18431843
"services": {
18441844
"additionalProperties": {

0 commit comments

Comments
 (0)