diff --git a/kitty/options/definition.py b/kitty/options/definition.py index facd72e63..7f22a89be 100644 --- a/kitty/options/definition.py +++ b/kitty/options/definition.py @@ -2417,13 +2417,14 @@ 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. +The terminal editor (such as ``vim`` or ``nano``) 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. If these variables aren't set, kitty will -run your shell (`$SHELL -l -c env`) to see if your shell config files set +run your shell (``$SHELL -l -c env``) to see if your shell config files set :envvar:`VISUAL` or :envvar:`EDITOR`. If that doesn't work, kitty will cycle -through various known editors (`vim`, `emacs`, etc) and take the first one +through various known editors (``vim``, ``emacs``, etc) and take the first one that exists on your system. ''' )