Merge branch 'docs-conf-fmt' of https://github.com/page-down/kitty

This commit is contained in:
Kovid Goyal 2021-11-22 20:17:47 +05:30
commit a824a45602
No known key found for this signature in database
GPG key ID: 06BC317B515ACE7C

View file

@ -194,11 +194,11 @@ def as_conf(self, commented: bool = False, level: int = 0, option_group: List['O
return ans
if option_group:
sz = max(len(self.name), max(len(o.name) for o in option_group))
a(f'{self.name.ljust(sz)} {self.defval_as_string}')
a(f'{self.name.ljust(sz)} {self.defval_as_string}'.rstrip())
for o in option_group:
a(f'{o.name.ljust(sz)} {o.defval_as_string}')
a(f'{o.name.ljust(sz)} {o.defval_as_string}'.rstrip())
else:
a(f'{self.name} {self.defval_as_string}')
a(f'{self.name} {self.defval_as_string}'.rstrip())
if self.long_text:
a('')
a(render_block(self.long_text))
@ -257,8 +257,10 @@ def as_conf(self, commented: bool = False, level: int = 0) -> List[str]:
a = ans.append
for k in self.items:
if k.documented:
prefix = '' if k.add_to_default else '# '
a(f'{prefix}{self.name} {k.defval_as_str}')
a(f'{self.name} {k.defval_as_str if k.add_to_default else ""}'.rstrip())
if not k.add_to_default and k.defval_as_str:
a('')
a(f'#: E.g. {self.name} {k.defval_as_str}'.rstrip())
if self.long_text:
a('')
a(render_block(self.long_text))
@ -273,7 +275,7 @@ def as_rst(self, conf_name: str, shortcut_slugs: Dict[str, Tuple[str, str]], kit
a('')
for k in self.items:
if k.documented:
a(f' {self.name:s} {k.defval_as_str}')
a(f' {self.name:s} {k.defval_as_str}'.rstrip())
a('')
if self.long_text:
a(expand_opt_references(conf_name, self.long_text))
@ -306,8 +308,9 @@ def as_conf(self, commented: bool = False, level: int = 0, action_group: List['M
if self.short_text:
a(render_block(self.short_text.strip())), a('')
for sc in [self] + action_group:
if sc.documented and sc.add_to_default:
a(sc.setting_name + ' ' + sc.parseable_text)
if sc.documented:
prefix = '' if sc.add_to_default else '#:: E.g. '
a(f'{prefix}{sc.setting_name} {sc.parseable_text}')
if self.long_text:
a(''), a(render_block(self.long_text.strip(), '#:: '))
a('')