Update documentation #97
Merged
Conversation
This file contains 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
hyrodium
commented
Sep 17, 2022
Codecov Report
@@ Coverage Diff @@
## master #97 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 197 199 +2
=========================================
+ Hits 197 199 +2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
sethaxen
reviewed
Sep 19, 2022
sethaxen
requested changes
Sep 19, 2022
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
hyrodium
commented
Oct 6, 2022
sethaxen
requested changes
Oct 15, 2022
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
|
Thanks for the suggestions! Should be ready for the final review. |
sethaxen
requested changes
Oct 16, 2022
There was a problem hiding this comment.
Just a few minor tweaks. There are a few warnings printed when the docs build. e.g. two of the real docstrings are being excluded. You may need to explicitly list their signatures in the @docs block. Also, the dual quaternions example links to the slerp docs, but no such docstring exists.
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
Co-authored-by: Seth Axen <[email protected]>
|
Thanks for the review again! I updated with the suggestions, and added a docstring for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds
docs/src/api.mdpage and adds more docstrings.Screenshot:
