From 9a56d619afc7ae941ab7dfe1400b7f81c387bfa6 Mon Sep 17 00:00:00 2001 From: egnor Date: Wed, 28 Jul 2021 22:15:33 -0700 Subject: [PATCH] clarify the text for the "editor" config variable slightly --- kitty/options/definition.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/kitty/options/definition.py b/kitty/options/definition.py index fb5f03136..dfcecea80 100644 --- a/kitty/options/definition.py +++ b/kitty/options/definition.py @@ -2417,10 +2417,12 @@ starts in interactive mode and reads its startup rc files. opt('editor', '.', long_text=''' -The console editor to use when editing the kitty config file or similar tasks. A -value of . means to use the environment variables VISUAL and EDITOR in that -order. Note that this environment variable has to be set not just in your shell -startup scripts but system-wide, otherwise kitty will not see it. +The console editor to use when editing the kitty config file or similar tasks. +The default value of . means to use the environment variables :envvar:`VISUAL` +and :envvar:`EDITOR` in that order. Note that these environment variables have +to be set when kitty starts, so if they're set in shell startup scripts but +kitty is launched directly from your desktop, kitty will not see them. In +that case you're better off naming your favorite editor here. ''' )