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

bounding boxes' tracks --> bounding boxes tracks #392

Merged
merged 5 commits into from
Jan 30, 2025
Merged

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Jan 28, 2025

Description

A small win towards next term 😉

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
There was inconsistency in our docs when referring to bounding boxes trajectories.

What does this PR do?

  • replaces all references to "bounding boxes' tracks" ---> "bounding boxes tracks"
  • removes the apostrophe from similar expressions (bounding boxes centroids, trajectories, dataset, arrays

References

#357

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?

It includes an update to the docstrings.

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

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.80%. Comparing base (41942e1) to head (4f39b69).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #392   +/-   ##
=======================================
  Coverage   99.80%   99.80%           
=======================================
  Files          15       15           
  Lines        1048     1048           
=======================================
  Hits         1046     1046           
  Misses          2        2           

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

@sfmig sfmig marked this pull request as ready for review January 28, 2025 15:53
@sfmig sfmig requested a review from a team January 28, 2025 15:53
Copy link
Collaborator

@lochhh lochhh left a comment

Choose a reason for hiding this comment

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

Thanks @sfmig for the small victory 😜
Just a general thought/question: given we have 'pose tracks', does it make more sense to have 'bounding box tracks' rather than 'bounding boxes tracks'? If we opt for the singular term, we could also use 'bounding box centroids' 🪱

docs/source/community/mission-scope.md Outdated Show resolved Hide resolved
docs/source/user_guide/input_output.md Outdated Show resolved Hide resolved
docs/source/user_guide/movement_dataset.md Outdated Show resolved Hide resolved
movement/io/load_bboxes.py Outdated Show resolved Hide resolved
movement/validators/datasets.py Outdated Show resolved Hide resolved
@niksirbi
Copy link
Member

Just a general thought/question: given we have 'pose tracks', does it make more sense to have 'bounding box tracks' rather than 'bounding boxes tracks'? If we opt for the singular term, we could also use 'bounding box centroids

My two cents on this:

personally I much prefer the singular "box" in "bounding box tracks" or "bounding box centroids". Afaik it's grammatically ok, since the plural is expressed in the "tracks" or "centroids". That said, I'm aware we had a vote on this (slack poll), and I think the version with the plural + apostrophe won out (as in "poses' tracks"). For reasons already stated I dislike the apostrophe so we are back to square one?

To bring this not-so-important issue to a close, I'm fine with either "bounding box tracks" or "bounding boxes tracks", but whatever we end up using should also apply to centroids.

@sfmig sfmig enabled auto-merge January 29, 2025 18:47
@lochhh lochhh force-pushed the smg/apostrophe-bboxes branch from 33a6f4f to 4f39b69 Compare January 30, 2025 17:23
@sfmig sfmig added this pull request to the merge queue Jan 30, 2025
Merged via the queue into main with commit 84b245c Jan 30, 2025
18 checks passed
@lochhh lochhh deleted the smg/apostrophe-bboxes branch January 30, 2025 18:10
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.

3 participants