-
Notifications
You must be signed in to change notification settings - Fork 10
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
Rename pose_tracks to position #149
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #149 +/- ##
=======================================
Coverage 99.28% 99.28%
=======================================
Files 9 9
Lines 556 557 +1
=======================================
+ Hits 552 553 +1
Misses 4 4 ☔ View full report in Codecov by Sentry. |
note: update poster examples |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM and thanks @niksirbi! Made a couple of suggestions here and there but nothing major.
Quality Gate passedIssues Measures |
Thanks for the very thorough review @lochhh! I've implemented your suggestions. |
Description
What is this PR
Why is this PR needed?
With the addition of kinematic data variables named
displacement
,velocity
,acceleration
etc., it's awkward to keep calling the variable containing posespose_tracks
. All of these variables are "tracks", in the sense that they are time-series.What does this PR do?
It renames the
xarray.DataArray
previously known aspose_tracks
toposition
. This is more consistent with the naming of the other variables. I also did some additional renaming in comments/docstrings and in a few variables/functions/class names, to ensure that they are consistent with the new terminology.Note that in many places in the docs and in comments/docstrings I decided to keep using the term "pose tracks". But this usage refers to the overall type of the data - i.e. tracks of poses over time - not the particular variable/attribute. This should become clearer once we address #69.
References
Closes #100
How has this PR been tested?
This kind of change would be very painful without existing tests. Our nearly universal test coverage allowed me to catch the few instances I'd missed. I fixed them and the tests all pass now.
Does this PR require an update to the documentation?
Yes, and I went through the docs and updated all instances I (and my IDEs) could find.
I've also updated an image that contained the term
pose_tracks
as the name of the correspondingDataArray
.How to review
The diff of this PR will be impossible to review directly, as almost all files have been affected. Perhaps it's more critical to go over our public docs and double-check that the term is used consistently there.
Checklist: