Clarify principal_axes() documentation regarding axis orientation#5311
Open
AkshitBoora wants to merge 3 commits intoMDAnalysis:developfrom
Open
Clarify principal_axes() documentation regarding axis orientation#5311AkshitBoora wants to merge 3 commits intoMDAnalysis:developfrom
AkshitBoora wants to merge 3 commits intoMDAnalysis:developfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5311 +/- ##
========================================
Coverage 93.82% 93.83%
========================================
Files 182 182
Lines 22487 22487
Branches 3196 3196
========================================
+ Hits 21099 21101 +2
+ Misses 925 924 -1
+ Partials 463 462 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jeremyleung521
added
the
more information needed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1828
Adds clarification to the documentation of
principal_axes()to explainthat the returned array contains principal axes as row vectors. This
helps avoid confusion where the coordinates may appear transposed
compared to column-vector conventions.
📚 Documentation preview 📚: https://mdanalysis--5311.org.readthedocs.build/en/5311/