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 module exception #506

Merged
merged 4 commits into from
Sep 8, 2024

Conversation

phi-friday
Copy link
Contributor

With this PR, I hope to make it easier to catch errors while using bayesian-optimization.

Copy link
Member

@till-m till-m left a comment

Choose a reason for hiding this comment

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

Could you add an exception.rst file in the docs such that we have these visible to users in the documentation?


from __future__ import annotations

__all__ = [
Copy link
Member

Choose a reason for hiding this comment

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

What is the advantage of declaring the exports explicitly?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When importing objects like from A import *, only the objects defined in __all__ should be imported.
I usually leave this in, but I'll remove it if it's not needed.

@phi-friday
Copy link
Contributor Author

Added reference/exception.rst.

Copy link

codecov bot commented Sep 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.21%. Comparing base (aed6a25) to head (f0249a5).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #506      +/-   ##
==========================================
+ Coverage   96.19%   96.21%   +0.02%     
==========================================
  Files          10       11       +1     
  Lines         867      872       +5     
==========================================
+ Hits          834      839       +5     
  Misses         33       33              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@till-m till-m merged commit 04670dd into bayesian-optimization:master Sep 8, 2024
13 checks passed
@phi-friday phi-friday deleted the feat-exceptions branch September 12, 2024 09:54
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