Skip to content

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
wants to merge 27 commits into from
Closed

Improve documentation #22

wants to merge 27 commits into from

Conversation

tekktrik
Copy link
Member

@tekktrik tekktrik commented Mar 25, 2022

This one was a doozy! I feel like there were a lot of places where I used bytes and circuitpython_typing.ReadableBuffer would have been fine, but the intention was really to use bytes 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 to setup.py and requirements.txt.

@tekktrik tekktrik added the documentation Improvements or additions to documentation label Mar 25, 2022
@tekktrik tekktrik requested a review from a team March 25, 2022 17:49
@tekktrik tekktrik mentioned this pull request Mar 25, 2022
@tekktrik tekktrik marked this pull request as draft March 30, 2022 17:11
@tekktrik tekktrik changed the title Add type annotations Improve documentation Mar 30, 2022
@tekktrik
Copy link
Member Author

Scope of the PR has increased, so updated initial comment.

@tekktrik tekktrik marked this pull request as ready for review March 30, 2022 17:22
@tekktrik tekktrik mentioned this pull request Apr 1, 2022
@tekktrik tekktrik marked this pull request as draft April 5, 2022 20:01
@tekktrik
Copy link
Member Author

tekktrik commented Apr 5, 2022

Going to separate out the changes from #25 from this PR, draft for now

@tekktrik
Copy link
Member Author

tekktrik commented Apr 7, 2022

Ew, ugly git commit history! Will resubmit.

@tekktrik tekktrik closed this Apr 7, 2022
@tekktrik tekktrik mentioned this pull request Apr 7, 2022
@kattni
Copy link
Contributor

kattni commented Apr 7, 2022

@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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Type Annotations
2 participants