Add further documentation & example usages #189
Conversation
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
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.
As a part of getting to know this library more, I decided to start by improving on things I personally found lacking when I first encountered the library. Currently, that stands as the lack of better examples and documentation. I have started by implemented further example usages, moving
start.pyand then documenting & building the docs for the relevant files.I feel this can be helpful to the community, especially catered towards newcomers who don't understand much about the library. I am going to be improving this further over the coming days, weeks or whenever I have time however I feel this is a good starting stage to begin this pull request.