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 raises in docstring for all PCIC and RPC classes and methods #37

Open
Galoshi opened this issue Mar 27, 2024 · 0 comments
Open

Add raises in docstring for all PCIC and RPC classes and methods #37

Galoshi opened this issue Mar 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Galoshi
Copy link
Collaborator

Galoshi commented Mar 27, 2024

Use raises to describe exceptions raised by your methods/classes.

:raises:
Exception: Explanation here.
For example, for a ValueError exception:

:raises:
ValueError: if fft_data is empty.

E.g.: editImage in application client

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant