-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
algebras: Improved documentation for Quaternion.rotate_point() #17691
Conversation
Earlier, documentation for rotate_point had some errors. Not sure if I should add more examples. Will do them if needed.
✅ Hi, I am the SymPy bot (v149). I'm here to help you write a release notes entry. Please read the guide on how to write release notes. Your release notes are in good order. Here is what the release notes will look like:
This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.5. Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it. Click here to see the pull request description that was parsed.
Update The release notes on the wiki have been updated. |
Codecov Report
@@ Coverage Diff @@
## master #17691 +/- ##
=============================================
- Coverage 74.702% 65.153% -9.549%
=============================================
Files 634 634
Lines 165662 165662
Branches 38962 38962
=============================================
- Hits 123754 107935 -15819
- Misses 36425 51781 +15356
- Partials 5483 5946 +463 |
sympy/algebras/quaternion.py
Outdated
Axis and angle of rotation. | ||
|
||
It's important to note that when r is a tuple, it must be of the form | ||
(axis, angle) |
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.
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.
Ok, I'll change it. Also, @sylee957 how can I check the numpydoc for any change I make in documentaion?
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.
Right now, there would be no other way than building the doc manually from sympy/doc
There is a open discussion to automate this process in #17597 though
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.
Oh, ok! Thanks!!
Earlier, documentation for rotate_point had some errors.
Not sure if I should add more examples. Will do them if needed.
References to other Issues or PRs
Fixes #17678
Brief description of what is fixed or changed
Other comments
Release Notes