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

Improving Docs #16

Merged
merged 5 commits into from
Nov 20, 2019
Merged

Improving Docs #16

merged 5 commits into from
Nov 20, 2019

Conversation

javierggt
Copy link
Contributor

@javierggt javierggt commented Sep 30, 2019

Following issue #11. This pull request improves documentation in two ways:

  • The detailed formulas that are used in the code are summarized in a page
  • The new API to accommodate vectorization is documented

There are still a couple of things I would like to do, but I would like to know what your expectations are. Is this enough? Do you need more explanation?

@taldcroft taldcroft changed the title WIP: Improving Docs Improving Docs Oct 1, 2019
Copy link
Contributor

@jeanconn jeanconn left a comment

Choose a reason for hiding this comment

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

I think maybe these broadcasting changes ended up on the wrong branch?
(and I see they are now removed 👍 from this branch; but it looks like github won't let me just delete this as it is a review comment).

@@ -0,0 +1,264 @@

Quaternion Quick Facts
Copy link
Contributor

Choose a reason for hiding this comment

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

I have not re-verified the math here. It is a great idea to have it but not sure if it will get peer review.

Copy link
Contributor

@jeanconn jeanconn left a comment

Choose a reason for hiding this comment

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

Except for the question about wanting the equatorial keyword in those docstring lines, this looks good to me.

@taldcroft taldcroft merged commit de90806 into master Nov 20, 2019
@taldcroft taldcroft deleted the docs branch November 20, 2019 14:32
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