[ENH]: Rename (f)ALFF markers to be shorter and ALFF prefixed #216

Merged
synchon merged 16 commits from refactor/alff-falff into main 2023-03-30 16:23:55 +00:00
synchon commented 2023-03-30 12:33:59 +00:00 (Migrated from github.com)
  • fix #(issue number)
  • description of feature/fix
  • tests added/passed
  • add an entry for the latest changes

This PR renames (f)ALFF markers to use shorter names and start with ALFF .i.e., ALFFParcels and ALFFSpheres.

* [ ] fix #(issue number) * [x] description of feature/fix * [x] tests added/passed * [x] add an entry for the latest changes This PR renames (f)ALFF markers to use shorter names and start with ALFF .i.e., `ALFFParcels` and `ALFFSpheres`.
codecov[bot] commented 2023-03-30 12:45:26 +00:00 (Migrated from github.com)

Codecov Report

Merging #216 (c2de9f6) into main (04a8d26) will increase coverage by 0.20%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #216      +/-   ##
==========================================
+ Coverage   93.33%   93.53%   +0.20%     
==========================================
  Files          80       80              
  Lines        3435     3452      +17     
  Branches      644      648       +4     
==========================================
+ Hits         3206     3229      +23     
+ Misses        151      145       -6     
  Partials       78       78              
Flag Coverage Δ
docs 100.00% <ø> (ø)
junifer 93.53% <100.00%> (+0.20%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
junifer/markers/__init__.py 100.00% <100.00%> (ø)
junifer/markers/falff/__init__.py 100.00% <100.00%> (ø)
junifer/markers/falff/falff_base.py 75.60% <100.00%> (ø)
junifer/markers/falff/falff_estimator.py 95.50% <100.00%> (ø)
junifer/markers/falff/falff_parcels.py 100.00% <100.00%> (ø)
junifer/markers/falff/falff_spheres.py 100.00% <100.00%> (ø)
junifer/markers/parcel_aggregation.py 100.00% <100.00%> (ø)

... and 10 files with indirect coverage changes

## [Codecov](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) Report > Merging [#216](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (c2de9f6) into [main](https://codecov.io/gh/juaml/junifer/commit/04a8d260a27779a1a6cb1717217d67ac9bc73866?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) (04a8d26) will **increase** coverage by `0.20%`. > The diff coverage is `100.00%`. [![Impacted file tree graph](https://codecov.io/gh/juaml/junifer/pull/216/graphs/tree.svg?width=650&height=150&src=pr&token=5H21JuZXMw&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) ```diff @@ Coverage Diff @@ ## main #216 +/- ## ========================================== + Coverage 93.33% 93.53% +0.20% ========================================== Files 80 80 Lines 3435 3452 +17 Branches 644 648 +4 ========================================== + Hits 3206 3229 +23 + Misses 151 145 -6 Partials 78 78 ``` | Flag | Coverage Δ | | |---|---|---| | docs | `100.00% <ø> (ø)` | | | junifer | `93.53% <100.00%> (+0.20%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml) | Coverage Δ | | |---|---|---| | [junifer/markers/\_\_init\_\_.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [junifer/markers/falff/\_\_init\_\_.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [junifer/markers/falff/falff\_base.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX2Jhc2UucHk=) | `75.60% <100.00%> (ø)` | | | [junifer/markers/falff/falff\_estimator.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX2VzdGltYXRvci5weQ==) | `95.50% <100.00%> (ø)` | | | [junifer/markers/falff/falff\_parcels.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX3BhcmNlbHMucHk=) | `100.00% <100.00%> (ø)` | | | [junifer/markers/falff/falff\_spheres.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL2ZhbGZmL2ZhbGZmX3NwaGVyZXMucHk=) | `100.00% <100.00%> (ø)` | | | [junifer/markers/parcel\_aggregation.py](https://codecov.io/gh/juaml/junifer/pull/216?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml#diff-anVuaWZlci9tYXJrZXJzL3BhcmNlbF9hZ2dyZWdhdGlvbi5weQ==) | `100.00% <100.00%> (ø)` | | ... and [10 files with indirect coverage changes](https://codecov.io/gh/juaml/junifer/pull/216/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=juaml)
fraimondo (Migrated from github.com) reviewed 2023-03-30 14:56:30 +00:00
@ -150,9 +150,8 @@ Features
- Implement :class:`junifer.markers.ReHoParcels` and
fraimondo (Migrated from github.com) commented 2023-03-30 14:56:29 +00:00

I would change this fragemtn to the right object: .ALFFParcels and .ALFFSphere

I would change this fragemtn to the right object: `.ALFFParcels` and `.ALFFSphere`
fraimondo (Migrated from github.com) requested changes 2023-03-30 14:58:37 +00:00
fraimondo (Migrated from github.com) left a comment

Docs are still failing.

I would rename every reference so it points to the right one, even old changsets. The point is to know who imlemented the class, even if the name of the class changed.

Docs are still failing. I would rename every reference so it points to the right one, even old changsets. The point is to know who imlemented the class, even if the name of the class changed.
github-actions[bot] commented 2023-03-30 15:37:58 +00:00 (Migrated from github.com)
PR Preview Action v1.3.0
Preview removed because the pull request was closed.
2023-03-30 16:29 UTC
[PR Preview Action](https://github.com/rossjrw/pr-preview-action) v1.3.0 :---: Preview removed because the pull request was closed. 2023-03-30 16:29 UTC <!-- Sticky Pull Request Commentpr-preview -->
fraimondo (Migrated from github.com) approved these changes 2023-03-30 16:22:23 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
juaml/junifer!216
No description provided.