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

Cleaning up doc strings #75

Merged
merged 4 commits into from
Dec 18, 2023
Merged

Cleaning up doc strings #75

merged 4 commits into from
Dec 18, 2023

Conversation

drewoldag
Copy link
Collaborator

@drewoldag drewoldag commented Nov 10, 2023

This is work that accrues to rail issue 22 (LSSTDESC/rail#22)

Multiple people are contributing to this PR. Generally we've broken up the rail_base repo by top level directories. In the following list, if there's a check box, it means that the directory has already been looked over.

  • cli
  • core (finished algo_utils, common_param, data)
  • creation (Creation docstrings #78)
  • estimation (partially finished with CatEstimator)
  • evaluation
  • example_data - not really any doc strings here.
  • stages - no doc strings here

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

@drewoldag drewoldag self-assigned this Nov 10, 2023
Copy link

codecov bot commented Nov 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (263b2a6) 96.96% compared to head (ca3aad5) 96.96%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #75   +/-   ##
=======================================
  Coverage   96.96%   96.96%           
=======================================
  Files          32       32           
  Lines        1714     1714           
=======================================
  Hits         1662     1662           
  Misses         52       52           

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

@drewoldag drewoldag marked this pull request as ready for review December 18, 2023 17:06
@drewoldag drewoldag requested review from eacharles and sschmidt23 and removed request for eacharles December 18, 2023 17:06
@drewoldag drewoldag linked an issue Dec 18, 2023 that may be closed by this pull request
Copy link
Collaborator

@sschmidt23 sschmidt23 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, thanks Drew.

Copy link
Collaborator

@eacharles eacharles left a comment

Choose a reason for hiding this comment

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

Thanks!

@drewoldag drewoldag merged commit 88953e8 into main Dec 18, 2023
6 checks passed
@drewoldag drewoldag deleted the issue/rail-22/clean-doc-strings branch February 12, 2024 05:03
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.

clean up docstrings
3 participants