Skip to content

Commit

Permalink
docs: fix doc-str for attributes in some spots (ApeWorX#2033)
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey authored Apr 29, 2024
1 parent eb4c373 commit 85ec73e
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/userguides/clis.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ class MyManager:
"""My custom manager."""

class CustomContext(ApeCliContextObject):
"""Add new managers to your custom context"""
my_manager: MyManager = MyManager()
"""Add new managers to your custom context"""

@property
def signer(self):
Expand Down
11 changes: 11 additions & 0 deletions src/ape/types/signatures.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,19 @@ def _left_pad_bytes(val: bytes, num_bytes: int) -> bytes:
@dataclass(frozen=True)
class _Signature:
v: int
"""
The version byte (``v``) in an Ethereum-style ECDSA signture.
"""

r: bytes
"""
The random point (``r``) in an ECDSA signature.
"""

s: bytes
"""
The signature proof point (``s``) in an ECDSA signature.
"""

def __iter__(self) -> Iterator[Union[int, bytes]]:
# NOTE: Allows tuple destructuring
Expand Down
2 changes: 1 addition & 1 deletion src/ape_ethereum/provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -1226,8 +1226,8 @@ class EthereumNodeProvider(Web3Provider, ABC):

name: str = "geth"

"""Is ``None`` until known."""
can_use_parity_traces: Optional[bool] = None
"""Is ``None`` until known."""

@property
def uri(self) -> str:
Expand Down
12 changes: 6 additions & 6 deletions src/ape_networks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ class CustomNetwork(PluginConfig):
A custom network config.
"""

"""Name of the network e.g. mainnet."""
name: str
"""Name of the network e.g. mainnet."""

"""Chain ID (required)."""
chain_id: int
"""Chain ID (required)."""

"""The name of the ecosystem."""
ecosystem: str
"""The name of the ecosystem."""

"""The base ecosystem plugin to use, when applicable. Defaults to the default ecosystem."""
base_ecosystem_plugin: Optional[str] = None
"""The base ecosystem plugin to use, when applicable. Defaults to the default ecosystem."""

"""The default provider plugin to use. Default is the default node provider."""
default_provider: str = "geth"
"""The default provider plugin to use. Default is the default node provider."""

"""The HTTP request header."""
request_header: Dict = {}
"""The HTTP request header."""


class NetworksConfig(PluginConfig):
Expand Down
2 changes: 1 addition & 1 deletion src/ape_test/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ class GasConfig(PluginConfig):
"""


"""Dict is for extra report settings."""
_ReportType = Union[bool, Dict]
"""Dict is for extra report settings."""


class CoverageReportsConfig(PluginConfig):
Expand Down
2 changes: 0 additions & 2 deletions tests/functional/test_contract.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

"""NOTE: This is testing Contract with a capital C."""

"""NOTE: This is testing contract with a capital C."""


def test_Contract_from_abi(contract_instance):
contract = Contract(contract_instance.address, abi=contract_instance.contract_type.abi)
Expand Down

0 comments on commit 85ec73e

Please sign in to comment.