-
Notifications
You must be signed in to change notification settings - Fork 3
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
naming consistency/clarity within src/rail/estimation #49
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #49 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 1 1
=========================================
Hits 1 1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let a couple of small comments. Pretty good looking.
Thanks @drewoldag for finding instances I missed! I think I've fixed them now. |
Change Description
This PR (and other concurrent PRs in the other repos) include renamings of modules and stages within
src/rail/estimation
for consistency and transparency to users as outlined in #37. (Expect a few more PRs to address the smaller set of necessary consistency/clarity changes outsidesrc/rail/estimation
using the same branch.)I request that multiple reviewers please do not hesitate to suggest changes as needed! The goals are consistency, clarity, and longevity, so if something looks unclear, inconsistent, or insufficiently flexible to accommodate future development, now is the time to make adjustments.
Solution Description
The following changes were made across all the rail repos, along with updates to the contributing documentation (which should be propagated to the rail python project template so prompts regarding naming are included in future PR checklists).
Code Quality
Bug Fix Checklist
Given that we are still pre-v1, I have not explicitly included backward compatibility, but a block of
import X as Y
can be constructed from the above list of changes. I updated the demos and scripts as best I could and checked that the tests still run locally, but it is possible that the smoke tests will uncover something I missed.Other Change Checklist
I fixed some instances of outdated descriptions in the demo notebooks, but others require more substantial editing, e.g. when they describe code that has long since been removed from the demo in question or aspects of the API that have significantly changed since the descriptions were written. The demos require a thorough review before v1 that's out of scope for this series of PRs.