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

Exposes more information for check_output decorator errors #139

Merged
merged 1 commit into from
Apr 13, 2023

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Apr 13, 2023

If the user does something that involves the mistyping target_ or tries to use a key word argument that doesn't map to a validator for the given output type, then the error will be cryptic. This adds context that it's for the check_output decorator and which function it's for.

Changes

  • raises nicer error message for check_output issues.

How I tested this

  • wrote unit test

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

If the user does something that involves the mistyping `target_` or
tries to use a key word argument that doesn't map to a validator for the given
output type, then the error will be cryptic. This adds context that it's
for the check_output decorator and which function it's for.
@skrawcz skrawcz requested a review from elijahbenizzy April 13, 2023 18:15
@skrawcz skrawcz merged commit c6b33e0 into main Apr 13, 2023
@skrawcz skrawcz deleted the contextualize_checkoutput_decorator_error branch April 13, 2023 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants