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 LSSTDESC/rail#37. (Expect a few more PRs to address the smaller set of necessary consistency/clarity changes outside src/rail/estimation using the same branch.)
[x] My PR includes a link to the issue that I am addressing
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).
[x] My code follows the code style of this project
[x] My code builds (or compiles) cleanly without any errors or warnings
[x] My code contains relevant comments and necessary documentation
Bug Fix Checklist
[X] My change includes a breaking change
[ ] My change includes backwards compatibility and deprecation warnings (if possible)
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.
Other Change Checklist
[X] I have updated the tutorial to highlight my new feature (if appropriate)
[x] I have updated unit/End-to-End (E2E) test cases to cover any changes
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.
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 LSSTDESC/rail#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.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.