KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Leave kitten_alias documented

Browse Source
This commit is contained in:
Kovid Goyal 2021-11-23 14:48:45 +05:30
parent a97a05b1ec
commit d7df4fa5dc
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
kitty/options/definition.py
View File

@ -2889,8 +2889,15 @@ Similarly, to alias kitten invocation::
opt('+kitten_alias', 'hints hints --hints-offset=0',
option_type='kitten_alias',
add_to_default=False, documented=False,
long_text='Deprecated, use :opt:`action_alias` instead.'
add_to_default=False,
long_text='''
Like :opt:`action_alias` above but, specifically for kittens. Generally,
prefer to use :opt:`action_alias`. This option is a legacy
version, present for backwards compatibility. It causes all invocations
of the aliased kitten to be substituted. So the example above will cause
all invocations of the hints kitten to have the :code:`--hints-offset=0`
option applied.
'''
)