Add a bunch of docstrings #6491
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
Collaborator
Author
|
Going to go ahead and merge this pre-review since
|
vdonato
added a commit
that referenced
this pull request
Apr 15, 2023
vdonato
added a commit
that referenced
this pull request
Apr 17, 2023
vdonato
added a commit
that referenced
this pull request
Apr 19, 2023
vdonato
added a commit
that referenced
this pull request
Apr 20, 2023
vdonato
added a commit
that referenced
this pull request
Apr 21, 2023
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.
📚 Context
We held off on writing docstrings for this feature until the APIs mostly stabilized, etc, so now that
that has happened we're all clear to add these!
Note that these docstrings are just my initial pass for them, and it's likely that there's still going to be
a good amount of editing to do from here by the documentation team.