Docs/add typeddict documentation #3802
Open
+1,058
−0
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.
What was wrong?
Related to Issue #1628
Closes #1628
The web3.types module contains 53 TypedDict definitions that enable IDE autocompletion and type checking, but these types were not documented. Third-party developers had to read the source code to understand the available types and their fields.
How was it fixed?
Added comprehensive documentation for TypedDict types in docs/types.rst:
Validation performed:
Notable clarification added:
Todo:
Cute Animal Picture
https://upload.wikimedia.org/wikipedia/commons/thumb/4/4d/Ball_python_lucy.JPG/1280px-Ball_python_lucy.JPG