Add basic documentation #6
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
This is mostly copying what's in comments in the code into actual doc files along with the existing docstrings. I've also added a couple of basic docstrings.
jrevels
reviewed
Apr 4, 2019
| `nothing` is returned. | ||
|
|
||
| See also: [`rrule`](@ref) | ||
| """ |
There was a problem hiding this comment.
frule returns a tuple of AbstractRules - one for each of the function's outputs.
Similarly, rrule returns a tuple of AbstractRules, one for each of the function's inputs.
If the returned tuple would only contain a single AbstractRule, the single AbstractRule may be returned directly (basically just matching Julia's return behavior).
jrevels
reviewed
Apr 4, 2019
docs/src/rules.md
Outdated
| end | ||
| return fx, dx | ||
| end | ||
| ``` |
There was a problem hiding this comment.
This kind of thing definitely belongs in an advanced usage section :)
|
Thanks for kicking the tires here! I'll add some commits to this branch as well; I've settled on a notation for certain parts of these, so I'll update |
…o remove dev notes until we can restructure them into an advanced tips section
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 is mostly copying what's in comments in the code into actual doc files along with the existing docstrings. I've also added a couple of basic docstrings.