Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix various typos in docstrings #308

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion neo3/api/helpers/txbuilder.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ async def set_valid_until_block(self) -> None:

async def calculate_network_fee(self) -> None:
"""
Calculates and set the system fee. Requires at least one signer.
Calculate and set the network fee. Requires at least one signer.
"""
if len(self.tx.witnesses) == 0:
if len(self.tx.signers) == 0:
Expand Down
2 changes: 1 addition & 1 deletion neo3/api/helpers/unwrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def as_public_key(res: noderpc.ExecutionResult, idx: int = 0) -> cryptography.EC
idx: the index in the result stack to fetch the stack item from.

Raises:
ValueError: if the index is out of range, or the value cannot be converted to a bool.
ValueError: if the index is out of range, or the value cannot be converted to an ECPoint.
ECCException: if the resulting key is not valid on the SECP256R1 curve.
"""
return item(res, idx).as_public_key()
Expand Down
8 changes: 4 additions & 4 deletions neo3/api/wrappers.py
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ async def invoke_multi(
append_system_fee: increase the calculated system fee with this amount.

Returns:
a list with the results of all exected functions.
a list with the results of all executed functions.

See Also:
`test_invoke_multi` - free equivalent for read only operations or testing.
Expand Down Expand Up @@ -525,7 +525,7 @@ async def invoke_multi_fast(
append_system_fee: increase the calculated system fee with this amount.

Returns:
a transaction ID if accepted by the network. Acceptance is does not guarantee successful execution.
a transaction ID if accepted by the network. Acceptance does not guarantee successful execution.
Acceptance means there are no transaction format errors. Use `invoke()` to wait for a receipt. The `state`
field of the receipt indicates if the transaction script executed successfully.

Expand Down Expand Up @@ -575,7 +575,7 @@ async def invoke_multi_raw(
append_system_fee: increase the calculated system fee with this amount.

Returns:
a list with the results of all exected functions.
a list with the results of all executed functions.

See Also:
`test_invoke_raw` - free equivalent for read only operations or testing.
Expand Down Expand Up @@ -623,7 +623,7 @@ async def _get_receipt_time_values(self) -> tuple[float, float]:

def add_signer(self, func: signing.SigningFunction, signer: verification.Signer):
"""
Add a `Signer` which will automatically be included when the various invoke functions.
Add a `Signer` that will automatically be included when the various invoke* functions are called.
"""
self._signing_funcs.append(func)
self.signers.append(signer)
Expand Down
2 changes: 1 addition & 1 deletion neo3/contracts/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Contract utilities for determing the contract hash, contract types, extracting public keys and signing treshold and more.
Contract utilities for determining the contract hash, contract types, extracting public keys and signing threshold and more.
"""
from typing import Type
from collections.abc import Sequence
Expand Down
Loading