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

Docs: add valid option values

Browse Source
This commit is contained in:
pagedown 2021-12-01 15:03:35 +08:00
parent af7a104f5b
commit d743206b8c
No known key found for this signature in database
GPG Key ID: E921CF18AC8FF6EB
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
kitty/options/definition.py
View File

@ -969,7 +969,12 @@ The tab bar style, can be one of:
'''
)
opt('tab_bar_align', 'left', choices=('left', 'center', 'right'), long_text='The horizontal alignment of the tab bar')
opt('tab_bar_align', 'left', choices=('left', 'center', 'right'),
long_text='''
The horizontal alignment of the tab bar, can be one of: :code:`left`,
:code:`center`, or :code:`right`.
'''
)
opt('tab_bar_min_tabs', '2',
option_type='tab_bar_min_tabs', ctype='uint',
@ -1136,12 +1141,19 @@ opt('background_image', 'none',
opt('background_image_layout', 'tiled',
choices=('mirror-tiled', 'scaled', 'tiled', 'clamped'), ctype='bglayout',
long_text='Whether to tile, scale or clamp the background image.'
long_text='''
Whether to tile, scale or clamp the background image. The value can be one of
:code:`tiled`, :code:`mirror-tiled`, :code:`scaled`, :code:`clamped`.
'''
)
opt('background_image_anchor', 'top-left',
choices=('top-left', 'top', 'top-right', 'left', 'center', 'right', 'bottom-left', 'bottom', 'bottom-right'), ctype='bganchor',
long_text='Where to position the background image in the window.'
long_text='''
Where to position the background image in the window. The value can be one of:
:code:`top-left`, :code:`top`, :code:`top-right`, :code:`left`, :code:`center`,
:code:`right`, :code:`bottom-left`, :code:`bottom`, :code:`bottom-right`.
'''
)
opt('background_image_linear', 'no',