Document InferDict and Message typed dicts #3323
Merged
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.
Resolves #3322
This adds key descriptions to
InferDict
andMessage
. Also adds theenumerate
key toInferDict
, which is the most commonly used key in our documentation. (I guess that would have been added once we add types topyro.infer.*
.)There are a few ways to document a
TypedDict
. I've opted to add a sphinx definition list in the main docstring.The second best alternative would be to add a """docstring""" below each key declaration, but those wouldn't show up in vscode hover, which I believe is more important.