Rename grav_index to curve_index
#68
Conversation
WalkthroughThis update primarily focuses on renaming the concept of "gravitropism index" to "curvature index" across multiple files. The changes include function name alterations, variable name updates, and adjustments in import statements. The package version has also been updated. Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (6)
- sleap_roots/init.py (2 hunks)
- sleap_roots/lengths.py (4 hunks)
- sleap_roots/scanline.py (1 hunks)
- sleap_roots/trait_pipelines.py (4 hunks)
- tests/test_lengths.py (6 hunks)
- tests/test_trait_pipelines.py (1 hunks)
Files skipped from review due to trivial changes (3)
- sleap_roots/scanline.py
- tests/test_lengths.py
- tests/test_trait_pipelines.py
Additional comments (Suppressed): 9
sleap_roots/__init__.py (2)
6-12: The import statement for
sleap_roots.lengthshas been added. Ensure that this module exists and is properly implemented in the codebase.20-20: The package version has been updated from "0.0.4" to "0.0.5". Make sure all dependencies and requirements are compatible with this new version.
sleap_roots/lengths.py (3)
114-123: The function
get_grav_indexhas been renamed toget_curve_index. The description of the function has also been updated to reflect this change. Ensure that all calls to this function throughout the codebase have been updated to match the new function name.148-151: The variable
grav_indexhas been renamed tocurve_index. This change is consistent with the renaming of the function and does not affect the logic of the code.158-161: The return statement has been updated to return
curve_indexinstead ofgrav_index. This change is consistent with the renaming of the function and the variable, and does not affect the logic of the code.sleap_roots/trait_pipelines.py (4)
36-39: The function
get_grav_indexhas been renamed toget_curve_index. Ensure that the new functionget_curve_indexmaintains the same functionality as the oldget_grav_indexfunction, or that any changes are intentional and correctly implemented.814-821: The trait name "grav_index" has been changed to "curve_index". Make sure all references to this trait in the codebase have been updated accordingly. Also, ensure that the change does not affect any external systems or reports that might be using the old trait name.
1192-1199: The trait name "main_grav_indices" has been changed to "main_curve_indices". As with the previous comment, verify that all references to this trait in the codebase have been updated and that the change does not impact any external systems or reports.
1294-1301: The trait name "grav_index" has been changed to "curve_index" here as well. As before, ensure all references to this trait in the codebase have been updated and that the change does not impact any external systems or reports.
Codecov Report
@@ Coverage Diff @@
## main #68 +/- ##
==========================================
+ Coverage 78.45% 78.48% +0.02%
==========================================
Files 13 13
Lines 803 804 +1
==========================================
+ Hits 630 631 +1
Misses 173 173
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
* Fix documentation * Import `lengths` in init * Change gravitropism to curvature
Summary by CodeRabbit
Refactor:
get_grav_indextoget_curve_indexacross all modules, reflecting its purpose more accurately in calculating the curvature index of a root.trait_pipelines.pyand test files.Test:
test_trait_pipelines.pyto check for negative values in the updated trait names.Chore:
These changes do not introduce new features or fix bugs but improve code readability and maintainability.