Add docstrings #56 #66
Merged
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
…the deprecated api, as well as type hinting. Type hinting will be a game changer, as it makes the docstrings way more clear (IMO).
Contributor
Author
|
@MarcCote Hopefully this should be good. Thanks! |
MarcCote
requested changes
Jan 22, 2024
Collaborator
MarcCote
left a comment
MarcCote
left a comment
There was a problem hiding this comment.
Great work! I made a couple of change requests but otherwise LGTM.
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Co-authored-by: Marc-Alexandre Côté <[email protected]>
Contributor
Author
|
Okay that should be good. Sorry you had to fix my dumb grammar mistakes haha |
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.
Added docstrings. In the future, I'm going to add type hinting, which will make the docstrings more clear. I think a higher level documentation page or two might be helpful, which I will work on after type hinting.