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

Documentation: distinguish between examples and default values for multi-valued options

Browse Source
This commit is contained in:
Kovid Goyal 2022-11-17 17:20:40 +05:30
parent e00a5ce911
commit 38547c9e7a
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
kitty/conf/types.py
View File

@ -331,11 +331,21 @@ class MultiOption:
ans: List[str] = [] ans: List[str] = []
a = ans.append a = ans.append
a(f'.. opt:: {conf_name}.{self.name}') a(f'.. opt:: {conf_name}.{self.name}')
if any(k.defval_as_str for k in self.items): documented = tuple(x for x in self.items if x.documented)
a('.. code-block:: conf') if any(k.defval_as_str for k in documented):
a('') defaults = tuple(x for x in documented if x.add_to_default)
for k in self.items: if defaults:
if k.documented: a('.. code-block:: conf')
a('')
for k in defaults:
a(f' {self.name:s} {k.defval_as_str}'.rstrip())
else:
a('')
a('Has no default values. Example values are shown below:')
a('')
a('.. code-block:: conf')
a('')
for k in self.items:
a(f' {self.name:s} {k.defval_as_str}'.rstrip()) a(f' {self.name:s} {k.defval_as_str}'.rstrip())
a('') a('')
if self.long_text: if self.long_text: