Open
Conversation
…module, enabling better IDE autocompletion and type checking support. Closes ethereum#1628
- Add BlockReceipts to Transactions section
- Add EthSubscriptionResult and GethSyncingSubscriptionResponse to Subscriptions
- Add RPCEndpoint to Aliases section
- Clarify that sign_transaction() returns eth_account.SignedTransaction object,
not a SignedTx TypedDict, with correct usage examples
Collaborator
|
@ilijapet is this still in draft? Are you ready for this to be reviewed? Can you mark it |
Contributor
Author
Contributor
Author
|
@fselmo here you can found script that I run https://gist.github.com/ilijapet/f3132324e648521882ed8b964755802f
|
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
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.
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