Improve async docstrings #2478
Merged
Improve async docstrings #2478
Conversation
This file contains 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
camfairchild
previously approved these changes
Nov 26, 2024
roman-opentensor
previously approved these changes
Nov 26, 2024
Comment on lines
2090
to
2104
| era: Specify mortality in blocks in follow format: | ||
| {'period': [amount_blocks]} If omitted the extrinsic is immortal |
There was a problem hiding this comment.
Suggested change
| era: Specify mortality in blocks in follow format: | |
| {'period': [amount_blocks]} If omitted the extrinsic is immortal | |
| era: Specify mortality in blocks in follow format: {'period': [amount_blocks]} If omitted the extrinsic is immortal |
Comment on lines
1052
to
1066
| auto_discover: Whether to automatically discover the type_registry presets based on the chain name and | ||
| typer registry |
There was a problem hiding this comment.
Suggested change
| auto_discover: Whether to automatically discover the type_registry presets based on the chain name and | |
| typer registry | |
| auto_discover: Whether to automatically discover the type_registry presets based on the chain name and typer registry |
Comment on lines
1050
to
1064
| use_remote_preset: When True preset is downloaded from Github master, otherwise use files from local | ||
| installed scalecodec package |
There was a problem hiding this comment.
Suggested change
| use_remote_preset: When True preset is downloaded from Github master, otherwise use files from local | |
| installed scalecodec package | |
| use_remote_preset: When True preset is downloaded from Github master, otherwise use files from local installed scalecodec package |
Comment on lines
1702
to
1716
| block_hash: the hash of the block — only supply this if not supplying the block | ||
| hash in the params, and not reusing the block hash |
There was a problem hiding this comment.
Suggested change
| block_hash: the hash of the block — only supply this if not supplying the block | |
| hash in the params, and not reusing the block hash | |
| block_hash: the hash of the block — only supply this if not supplying the block hash in the params, and not reusing the block hash |
Comment on lines
1769
to
1783
| call_params: This is a dict containing the params of the call. e.g. | ||
| `{'dest': 'EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk', 'value': 1000000000000}` |
There was a problem hiding this comment.
Suggested change
| call_params: This is a dict containing the params of the call. e.g. | |
| `{'dest': 'EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk', 'value': 1000000000000}` | |
| call_params: This is a dict containing the params of the call. e.g. `{'dest': 'EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk', 'value': 1000000000000}` |
Comment on lines
+2349
to
+2363
| keypair: Keypair of the sender, does not have to include private key because no valid signature is | ||
| required |
There was a problem hiding this comment.
Suggested change
| keypair: Keypair of the sender, does not have to include private key because no valid signature is | |
| required | |
| keypair: Keypair of the sender, does not have to include private key because no valid signature is required |
Comment on lines
2452
to
2466
| max_results: the maximum of results required, if set the query will stop fetching results when number is | ||
| reached |
There was a problem hiding this comment.
Suggested change
| max_results: the maximum of results required, if set the query will stop fetching results when number is | |
| reached | |
| max_results: the maximum of results required, if set the query will stop fetching results when number is reached |
Comment on lines
2456
to
2470
| ignore_decoding_errors: When set this will catch all decoding errors, set the item to None and continue | ||
| decoding |
There was a problem hiding this comment.
Suggested change
| ignore_decoding_errors: When set this will catch all decoding errors, set the item to None and continue | |
| decoding | |
| ignore_decoding_errors: When set this will catch all decoding errors, set the item to None and continue decoding |
Comment on lines
+2458
to
+2472
| reuse_block_hash: use True if you wish to make the query using the last-used block hash. Do not mark True | ||
| if supplying a block_hash |
There was a problem hiding this comment.
Suggested change
| reuse_block_hash: use True if you wish to make the query using the last-used block hash. Do not mark True | |
| if supplying a block_hash | |
| reuse_block_hash: use True if you wish to make the query using the last-used block hash. Do not mark True if supplying a block_hash |
Co-authored-by: Cameron Fairchild <cameron@opentensor.dev>
b0c024e to
be3c228
Compare
roman-opentensor
previously approved these changes
Nov 26, 2024
roman-opentensor
approved these changes
Nov 26, 2024
Merged
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.
Improves the docstrings for async_substrate_interface