diff options
Diffstat (limited to 'sphinx/ext/napoleon/docstring.py')
| -rw-r--r-- | sphinx/ext/napoleon/docstring.py | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index cb8a5e1cd..8594cdfc3 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -410,7 +410,7 @@ class GoogleDocstring: def _format_admonition(self, admonition: str, lines: list[str]) -> list[str]: lines = self._strip_empty(lines) if len(lines) == 1: - return ['.. %s:: %s' % (admonition, lines[0].strip()), ''] + return [f'.. {admonition}:: {lines[0].strip()}', ''] elif lines: lines = self._indent(self._dedent(lines), 3) return ['.. %s::' % admonition, ''] + lines + [''] @@ -443,13 +443,13 @@ class GoogleDocstring: _desc = self._strip_empty(_desc) if any(_desc): _desc = self._fix_field_desc(_desc) - field = ':%s %s: ' % (field_role, _name) + field = f':{field_role} {_name}: ' lines.extend(self._format_block(field, _desc)) else: - lines.append(':%s %s:' % (field_role, _name)) + lines.append(f':{field_role} {_name}:') if _type: - lines.append(':%s %s: %s' % (type_role, _name, _type)) + lines.append(f':{type_role} {_name}: {_type}') return lines + [''] def _format_field(self, _name: str, _type: str, _desc: list[str]) -> list[str]: @@ -459,16 +459,16 @@ class GoogleDocstring: if _name: if _type: if '`' in _type: - field = '**%s** (%s)%s' % (_name, _type, separator) + field = f'**{_name}** ({_type}){separator}' else: - field = '**%s** (*%s*)%s' % (_name, _type, separator) + field = f'**{_name}** (*{_type}*){separator}' else: - field = '**%s**%s' % (_name, separator) + field = f'**{_name}**{separator}' elif _type: if '`' in _type: - field = '%s%s' % (_type, separator) + field = f'{_type}{separator}' else: - field = '*%s*%s' % (_type, separator) + field = f'*{_type}*{separator}' else: field = '' @@ -657,7 +657,7 @@ class GoogleDocstring: field = ':ivar %s: ' % _name lines.extend(self._format_block(field, _desc)) if _type: - lines.append(':vartype %s: %s' % (_name, _type)) + lines.append(f':vartype {_name}: {_type}') else: lines.append('.. attribute:: ' + _name) if self._opt and 'noindex' in self._opt: @@ -770,7 +770,7 @@ class GoogleDocstring: _type = ' ' + _type if _type else '' _desc = self._strip_empty(_desc) _descs = ' ' + '\n '.join(_desc) if any(_desc) else '' - lines.append(':raises%s:%s' % (_type, _descs)) + lines.append(f':raises{_type}:{_descs}') if lines: lines.append('') return lines @@ -1338,7 +1338,7 @@ class NumpyDocstring(GoogleDocstring): last_had_desc = True for name, desc, role in items: if role: - link = ':%s:`%s`' % (role, name) + link = f':{role}:`{name}`' else: link = ':obj:`%s`' % name if desc or last_had_desc: |