Skip to content

DOC: Clarify that types in docstrings do not use formal type annotation syntax #30132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2025
Merged

DOC: Clarify that types in docstrings do not use formal type annotation syntax #30132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/devel/document.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,10 @@ understandable by humans. If the possible types are too complex use a
simplification for the type description and explain the type more
precisely in the text.

We do not use formal type annotation syntax for type descriptions in
docstrings; e.g. we use ``list of str`` rather than ``list[str]``; we
use ``int or str`` rather than ``int | str`` or ``Union[int, str]``.

Generally, the `numpydoc docstring guide`_ conventions apply. The following
rules expand on them where the numpydoc conventions are not specific.

Expand Down