summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Duffield <jessedduffield@gmail.com>2023-05-04 16:53:13 +1000
committerJesse Duffield <jessedduffield@gmail.com>2023-05-04 16:53:13 +1000
commit3cac14c76e5c968c5c134306d905a98d300bf308 (patch)
tree5484230549c9fda6e5c7a447d21f32143c209aaa
parent1636931c2b11695846241933a4d7e8d61609e766 (diff)
add comment to encourage keeping code and docs in sync
-rw-r--r--pkg/config/editor_presets.go1
1 files changed, 1 insertions, 0 deletions
diff --git a/pkg/config/editor_presets.go b/pkg/config/editor_presets.go
index d461112d0..76b9d5996 100644
--- a/pkg/config/editor_presets.go
+++ b/pkg/config/editor_presets.go
@@ -35,6 +35,7 @@ type editPreset struct {
editInTerminal bool
}
+// IF YOU ADD A PRESET TO THIS FUNCTION YOU MUST UPDATE THE `Supported presets` SECTION OF docs/Config.md
func getPreset(osConfig *OSConfig, guessDefaultEditor func() string) *editPreset {
presets := map[string]*editPreset{
"vi": standardTerminalEditorPreset("vi"),