From a42b16438efc1f5b5ed901a96784d9b210bcf965 Mon Sep 17 00:00:00 2001
From: Ivo Maceira <ivomaceira@gmail.com>
Date: Mon, 5 May 2025 22:20:23 +0200
Subject: [PATCH] Fix openDirInEditor docs to mention parameter

---
 docs/Config.md                | 2 +-
 pkg/config/app_config_test.go | 2 +-
 pkg/config/user_config.go     | 2 +-
 schema/config.json            | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/Config.md b/docs/Config.md
index 906b292a8..c5bcd1e7d 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -425,7 +425,7 @@ os:
   # Whether lazygit suspends until an edit process returns
   editInTerminal: false
 
-  # For opening a directory in an editor
+  # For opening a directory in an editor. Should contain "{{dir}}".
   openDirInEditor: ""
 
   # A built-in preset that sets all of the above settings. Supported presets
diff --git a/pkg/config/app_config_test.go b/pkg/config/app_config_test.go
index 98c82d8ee..0754355c3 100644
--- a/pkg/config/app_config_test.go
+++ b/pkg/config/app_config_test.go
@@ -555,7 +555,7 @@ os:
   # Whether lazygit suspends until an edit process returns
   editInTerminal: false
 
-  # For opening a directory in an editor
+  # For opening a directory in an editor. Should contain "{{dir}}".
   openDirInEditor: ""
 
   # A built-in preset that sets all of the above settings. Supported presets
diff --git a/pkg/config/user_config.go b/pkg/config/user_config.go
index 9c6160f68..0df18b09b 100644
--- a/pkg/config/user_config.go
+++ b/pkg/config/user_config.go
@@ -570,7 +570,7 @@ type OSConfig struct {
 	// [dev] We're naming this `editInTerminal` for backwards compatibility
 	SuspendOnEdit *bool `yaml:"editInTerminal,omitempty"`
 
-	// For opening a directory in an editor
+	// For opening a directory in an editor. Should contain "{{dir}}".
 	OpenDirInEditor string `yaml:"openDirInEditor,omitempty"`
 
 	// A built-in preset that sets all of the above settings. Supported presets
diff --git a/schema/config.json b/schema/config.json
index 4efe65f45..dd5ebdc2c 100644
--- a/schema/config.json
+++ b/schema/config.json
@@ -1543,7 +1543,7 @@
         },
         "openDirInEditor": {
           "type": "string",
-          "description": "For opening a directory in an editor"
+          "description": "For opening a directory in an editor. Should contain \"{{dir}}\"."
         },
         "editPreset": {
           "type": "string",