Skip to content

[docs] Add that type hinting is unnecessary for test cases #3496

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

Open
tepals wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −1
Open

[docs] Add that type hinting is unnecessary for test cases #3496

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
3 changes: 2 additions & 1 deletion doc/develop/coding-guidelines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ For example, when type information is refined in the docstring.


In test classes, it is recommended to have one-line docstring for each test method. For very short and obvious
tests, where the function name explain what all it does, then in such cases, the docstring can be omitted.
tests, where the function name explain what all it does, then in such cases, the docstring can be omitted. As test
functions only have self as input argument and no return value, type hinting in the function signature is not required.

For e.g. 2.3 the test class should be defined as
Comment on lines 162 to 166

Expand Down
Loading