ayo/kitty
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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 @@ def as_rst(self, conf_name: str, shortcut_slugs: Dict[str, Tuple[str, str]], kit
ans: List[str] = []
a = ans.append
a(f'.. opt:: {conf_name}.{self.name}')
if any(k.defval_as_str for k in self.items):
a('.. code-block:: conf')
a('')
for k in self.items:
if k.documented:
documented = tuple(x for x in self.items if x.documented)
if any(k.defval_as_str for k in documented):
defaults = tuple(x for x in documented if x.add_to_default)
if defaults:
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('')
if self.long_text: