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.

Sign up for GitHub

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

Jump to bottom

Document exceptions for __init__ and from_dict() methods in Metadata API #1819

Closed
MVrachev opened this issue Feb 2, 2022 · 0 comments · Fixed by #1820
Closed

Document exceptions for __init__ and from_dict() methods in Metadata API #1819

MVrachev opened this issue Feb 2, 2022 · 0 comments · Fixed by #1820
Assignees
@MVrachev
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Milestone
sprint 16

Comments

@MVrachev
Copy link
Collaborator

MVrachev commented Feb 2, 2022

Document ValueError (and KeyError if needed) exceptions for __init__ and from_dict() methods in Metadata API.

The reason this was not done is that this sort of makes it looks like the programmer should handle these errors... but as long as we are clear in the docstring that these are invalid argument errors, this should be fine

For context read #1785
@MVrachev MVrachev self-assigned this Feb 2, 2022
@MVrachev MVrachev mentioned this issue Feb 2, 2022
Closed
@MVrachev MVrachev added the 1.0.0 blockers To be addressed before 1.0.0 release label Feb 2, 2022
@MVrachev MVrachev added this to the sprint 16 milestone Feb 2, 2022
This was referenced Feb 3, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MVrachev MVrachev

Labels
1.0.0 blockers To be addressed before 1.0.0 release
Projects
None yet
Milestone
sprint 16
Development

Successfully merging a pull request may close this issue.

Add exceptions docs for __init__ and from_dict() MVrachev/tuf
1 participant
@MVrachev