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

Set __all__ #72

Merged
merged 10 commits into from
Dec 17, 2023
Merged

Set __all__ #72

merged 10 commits into from
Dec 17, 2023

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Dec 16, 2023

  1. Avoids littering the namespace on star imports more than necessary
  2. Simplifies cross-references to documentation, e.g., in addition to petab_select.problem.Problem, we can also now reference petab_select.Problem. This wasn't possible before.
  3. Now also https://petab-select--72.org.readthedocs.build/en/72/generated/petab_select.html is populated. (To be decided whether we want to have only the top-level imports or only the individual modules.)

@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7c71053) 60.61% compared to head (082b254) 60.92%.
Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop      #72      +/-   ##
===========================================
+ Coverage    60.61%   60.92%   +0.30%     
===========================================
  Files           14       14              
  Lines         1521     1533      +12     
===========================================
+ Hits           922      934      +12     
  Misses         599      599              

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

1. Avoids littering the namespace on star imports more than necessary
2. Simplifies cross-references to documentation,
   e.g., in addition to `petab_select.problem.Problem`, we can also
   now reference `petab_select.Problem`. This wasn't possible before.
Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

Looks good. Many methods aren't expected to be used by users directly (e.g. in misc.py), but fine to doc them anyway

petab_select/candidate_space.py Outdated Show resolved Hide resolved
@dweindl
Copy link
Member Author

dweindl commented Dec 16, 2023

Many methods aren't expected to be used by users directly

Agreed. Feel free to remove those, I didn't want break anything already using petab_select. Merge at your convenience.

e.g. in misc.py

There is petab_select/__init__.py:from .misc import *, that should then probably be removed.

@dilpath dilpath merged commit f9a2a87 into develop Dec 17, 2023
3 checks passed
@dilpath dilpath deleted the all__ branch December 17, 2023 13:37
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.

3 participants