Skip to content

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

@confluence

Description

@confluence

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.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions