Skip to content

Commit 98613b8

Browse files
committed
Fix some unnecessary line breaks.
1 parent 8112aed commit 98613b8

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

stack/documenting-code-with-type-annotations.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ Documentation built with `Documenteer 2.x`_ can often leave this information out
1414
Function arguments
1515
------------------
1616

17-
To document the parameters to a function or method declared with type hints,
18-
use regular numpydoc style without the colon or the type information that follows it::
17+
To document the parameters to a function or method declared with type hints, use regular numpydoc style without the colon or the type information that follows it::
1918

2019
def run_thing(self, x: int, *args: int, name: str = "", **kwargs: str) -> None:
2120
"""Run the thing.
@@ -106,8 +105,7 @@ Their docstrings should continue to include the types parenthetically::
106105
"""Value of the thing (`int`)."""
107106

108107
.. note::
109-
Attributes without default values (or some sort of ``= RHS``) are not
110-
included in documentation *at all*, except for those on `~dataclasses.dataclass` types.
108+
Attributes without default values (or some sort of ``= RHS``) are not included in documentation *at all*, except for those on `~dataclasses.dataclass` types.
111109
Important instance attributes that cannot have a class-level default value should be made into properties so they can be documented.
112110

113111
Generics

0 commit comments

Comments
 (0)