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 required_mod_options #413

Merged
merged 3 commits into from
Jan 31, 2023
Merged

Add required_mod_options #413

merged 3 commits into from
Jan 31, 2023

Conversation

gabegma
Copy link
Contributor

@gabegma gabegma commented Jan 31, 2023

Resolve #114

Description:

  • When calling a module without mandatory mod_options, it would sometimes fail silently, or the error message would be hard to understand. This proposal makes it clear when specific mod_options are required.

Checklist:

You should check all boxes before the PR is ready. If a box does not apply, check it to acknowledge it.

  • ISSUE NUMBER. You linked the issue number (Ex: Resolve #XXX).
  • PRE-COMMIT. You ran pre-commit on all commits, or else, you
    ran pre-commit run --all-files at the end.
  • USER CHANGES. The changes are added to CHANGELOG.md and the documentation, if they impact
    our users.
  • DEV CHANGES.
    • Update the documentation if this PR changes how to develop/launch on the app.
    • Update the README files and our wiki for any big design decisions, if relevant.
    • Add unit tests, docstrings, typing and comments for complex sections.

@gabegma gabegma marked this pull request as ready for review January 31, 2023 19:08
Copy link
Contributor

@JosephMarinier JosephMarinier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! 👍 Thank you!

gabegma and others added 2 commits January 31, 2023 16:13
Co-authored-by: Joseph Marinier <joseph.marinier@servicenow.com>
@gabegma gabegma merged commit 7c91dc6 into main Jan 31, 2023
@gabegma gabegma deleted the ggm/add-required-mod-options branch January 31, 2023 22:11
@gabegma gabegma mentioned this pull request Feb 1, 2023
4 tasks
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.

Add required_mod_options and raise when mod_options are missing them
2 participants