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

Removed "analysis" level from namespace #333

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Removed "analysis" level from namespace #333

merged 1 commit into from
Oct 24, 2024

Conversation

niksirbi
Copy link
Member

@niksirbi niksirbi commented Oct 24, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Refactoring

Why is this PR needed?

Closes #320.

The "analysis" folder was unnecessary, because it only contains the kinematics.py module, and it made our import statements unnecessarily long and complicated.

What does this PR do?

I removed the analysis folder, and moved kinematics.py to be a "top-level" module - i.e. instead of movement.analysis.kinematics we have movement.kinematics.

I then searched and replaced .analysis.kinematics with .kinematics, throughout the repo.

References

Related to #327 and #328, but those will be further discussed and tackled separately.

How has this PR been tested?

Existing tests still pass, and docs still build successfully.

Is this a breaking change?

Yes.

Does this PR require an update to the documentation?

Automatically done.

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

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.76%. Comparing base (f7f3b48) to head (4867406).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #333   +/-   ##
=======================================
  Coverage   99.76%   99.76%           
=======================================
  Files          14       14           
  Lines         846      846           
=======================================
  Hits          844      844           
  Misses          2        2           

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

@niksirbi niksirbi marked this pull request as ready for review October 24, 2024 13:06
@niksirbi niksirbi requested a review from lochhh October 24, 2024 13:06
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.

🚀

@lochhh lochhh added this pull request to the merge queue Oct 24, 2024
Merged via the queue into main with commit 1b6b44d Oct 24, 2024
27 checks passed
@lochhh lochhh deleted the drop-analysis-level branch October 25, 2024 16:36
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.

Drop analysis level
2 participants