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

algebras: Improved documentation for Quaternion.rotate_point() #17691

Merged
merged 4 commits into from
Oct 4, 2019

Conversation

supreet11agrawal
Copy link
Contributor

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

  • algebras
    • Corrected documentation for Quaternion.rotate_point().

Earlier, documentation for rotate_point had some errors.
Not sure if I should add more examples. Will do them if needed.
@sympy-bot
Copy link

sympy-bot commented Oct 3, 2019

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.

Earlier, documentation for rotate_point had some errors.
Not sure if I should add more examples. Will do them if needed.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234". See
https://github.com/blog/1506-closing-issues-via-pull-requests . Please also
write a comment on that issue linking back to this pull request once it is
open. -->

Fixes #17678 

#### Brief description of what is fixed or changed


#### Other comments


#### Release Notes

<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. The bot will check your release notes
automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* algebras
  * Corrected documentation for Quaternion.rotate_point().
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@codecov
Copy link

codecov bot commented Oct 3, 2019

Codecov Report

Merging #17691 into master will decrease coverage by 9.548%.
The diff coverage is n/a.

@@              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 Show resolved Hide resolved
Axis and angle of rotation.

It's important to note that when r is a tuple, it must be of the form
(axis, angle)
Copy link
Member

Choose a reason for hiding this comment

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

I think that this should be indented.
Currently, the numpydoc extension treats any non-indented block under Parameters as a parameter name
image

Copy link
Contributor Author

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?

Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, ok! Thanks!!

@sylee957 sylee957 merged commit dc63f74 into sympy:master Oct 4, 2019
@supreet11agrawal supreet11agrawal deleted the 17678_quaternion branch October 4, 2019 12:02
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.

Unclear documentation in Quaternion.rotate_point()
4 participants