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

Python Docstring: Raises missing #63

Closed
RedingJeff opened this issue Oct 19, 2021 · 3 comments · Fixed by #54
Closed

Python Docstring: Raises missing #63

RedingJeff opened this issue Oct 19, 2021 · 3 comments · Fixed by #54
Assignees
Labels
feature request Request a potential feature

Comments

@RedingJeff
Copy link
Contributor

Most methods are missing the Raises part in the Docstring commands.

Some are informing about possible Error raises in the description, but not all.

I would suggest adding the Raises tag and detail information to all methods that could raise an error. With this it is directly clear to the user if he needs to handle errors and which types to expect.

@tstorek
Copy link
Collaborator

tstorek commented Oct 20, 2021

@RedingJeff mostly out should be requesrexeptions

@tstorek
Copy link
Collaborator

tstorek commented Nov 24, 2021

linked to #51

@tstorek tstorek linked a pull request Nov 24, 2021 that will close this issue
@tstorek tstorek reopened this Jan 16, 2022
@tstorek tstorek added the feature request Request a potential feature label Jan 17, 2022
Copy link

github-actions bot commented Feb 6, 2024

Branch 63-Python-Docstring-Raises-missing created!

@djs0109 djs0109 closed this as completed Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request a potential feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants