Skip to content
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.

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

add return-description-missing violation #525

Closed
jshwi opened this issue Jan 27, 2025 · 0 comments · Fixed by #526
Closed

add return-description-missing violation #525

jshwi opened this issue Jan 27, 2025 · 0 comments · Fixed by #526
Assignees

Comments

@jshwi
Copy link
Owner

jshwi commented Jan 27, 2025

$ cat example.py
# def normalize(ticker: str) -> str:
#     """Normalize ticket names.
#
#     :param ticket: name to normalize.
#     :return:
#     """

should raise:

$ docsig example.py
# example.py:2 in normalize
#     SIG506: description missing from return (return-description-missing)
@jshwi jshwi self-assigned this Jan 27, 2025
jshwi added a commit that referenced this issue Jan 27, 2025
@jshwi jshwi linked a pull request Jan 27, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant