Merged
Conversation
* doc apparently depends on the generated JSON. * Use remake-style comment.
rocky
approved these changes
Feb 8, 2021
Member
There was a problem hiding this comment.
I built and looked at.
I suppose this is a great start. I looked at and the information doesn't feel to me reading this it would be that much more helpful than simply looking at the code. But I suppose there are some that prefer this kind of document, so let's do it.
In my experience, giving concrete examples on how to use this class goes a long way.
But I suppose that can come later.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 a follow up to #11 (comment). Feel free to improve the documentation as you wish. After this is merged someone should hook things up with readthedocs, I don't know how to do that.