neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
77 stars 7 forks source link

Suggestion to rename ValidPosesCSV to ValidDeepLabCutCSV #195

Closed sfmig closed 1 month ago

sfmig commented 1 month ago

Description

What is this PR

Why is this PR needed? The class defines a specific Deeplabcut csv format, rather than a common format in pose estimation more generally. This is clarified in the docstring but maybe it would be nice to make it more explicit with the class name.

What does this PR do? Renames the validator class ValidPosesCSV to ValidDeepLabCutCSV.

Not sure about the high/lower case dance though, so happy to hear thoughts 👀

References

None.

How has this PR been tested?

Tests pass locally and in CI.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

No.

Checklist:

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.68%. Comparing base (ffa7311) to head (f9644e2).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #195 +/- ## ======================================= Coverage 99.68% 99.68% ======================================= Files 11 11 Lines 638 638 ======================================= Hits 636 636 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.