Improve the help message for the kitten remote control cmd

This commit is contained in:
Kovid Goyal 2018-07-25 09:49:01 +05:30
parent 007f377f16
commit 21dbb0e820
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C

View File

@ -685,7 +685,10 @@ def set_background_opacity(boss, window, payload):
# kitten {{{
@cmd(
'Run a kitten',
'Run a kitten over the specified window (active window by default)',
'Run a kitten over the specified window (active window by default).'
' The :italic:`kitten_name` can be either the name of a builtin kitten'
' or the path to a python file containing a custom kitten. If a relative path'
' is used it is searched for in the kitty config directory.',
options_spec=MATCH_WINDOW_OPTION,
argspec='kitten_name',
)