-
Notifications
You must be signed in to change notification settings - Fork 12
Improve documentation #22
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
Closed
Closed
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
Closed
Scope of the PR has increased, so updated initial comment. |
Merged
Going to separate out the changes from #25 from this PR, draft for now |
Signed-off-by: Kattni Rembor <[email protected]>
Ew, ugly git commit history! Will resubmit. |
Merged
@tekktrik We don't mind lengthy git histories. You don't need to close PRs and resubmit them solely for that reason. Please feel free to stick with PRs regardless of the git history. Thanks for all you've been doing! |
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 one was a doozy! I feel like there were a lot of places where I used
bytes
andcircuitpython_typing.ReadableBuffer
would have been fine, but the intention was really to usebytes
so I did that.Also added some documentation updates related to type annotation, but this library would benefit from more thorough documentation of parameters.
Resolves #19
UPDATE
This PR further improves documentation by cleaning up a lot of the module, class, and method docstrings, then adding the missing modules to
api.rst
so said documentation will be displayed.Also, this library seemed to have an undocumented dependency on
pyasn1
so I added it tosetup.py
andrequirements.txt
.