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

Documentation: automatically add validation exception to decorated function docstring #114

Open
confluence opened this issue May 17, 2023 · 0 comments
Assignees

Comments

@confluence
Copy link
Collaborator

This is a documentation nice-to-have: all functions decorated with validate can raise a CartaValidationFailed exception, and this should be added to the modified docstring automatically together with the Raises section if it does not exist.

Additionally, these functions don't currently all report their additional internal exceptions, and this should be fixed.

@confluence confluence self-assigned this May 17, 2023
@Kechil Kechil added this to CARTA Sep 18, 2023
@Kechil Kechil moved this to In progress in CARTA Sep 18, 2023
@kswang1029 kswang1029 removed this from CARTA Dec 6, 2023
@kswang1029 kswang1029 added this to CARTA Dec 6, 2023
@kswang1029 kswang1029 moved this to Icebox in CARTA Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Icebox
Development

No branches or pull requests

1 participant