Skip to content
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

Suggestion to rename ValidPosesCSV to ValidDeepLabCutCSV #195

Merged
merged 1 commit into from
May 28, 2024

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented May 28, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

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:

  • The code has been tested locally
  • [ n/a ] Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link

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

Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call!
I also wanted to rename it, and for the same reason.
Hadn't come up with a suitable capitalisation scheme 😉
I'm fine with this new name. It's anyway most relevant for other developers, users won't have to interact with this object.

@sfmig sfmig added this pull request to the merge queue May 28, 2024
Merged via the queue into main with commit 426003c May 28, 2024
17 checks passed
@niksirbi niksirbi deleted the smg/validator-rename branch May 28, 2024 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants