Skip to content

Commit 8149667

Browse files
antazoeyfubuloubu
andauthored
docs: fix doc warnings (#2777)
Co-authored-by: El De-dog-lo <3859395+fubuloubu@users.noreply.github.com>
1 parent 3b8ef0b commit 8149667

3 files changed

Lines changed: 7 additions & 9 deletions

File tree

src/ape/api/accounts.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -538,8 +538,8 @@ def delegate_to(
538538
doing a critical action temporarily, such as using an EIP7702 delegate module.
539539
540540
Args:
541-
new_delegate (`:class:~ape.contracts.ContractInstance`):
542-
The contract instance to override the `delegate` with.
541+
new_delegate (:class:`~ape.contracts.ContractInstance`):
542+
The contract instance to override the ``delegate`` with.
543543
set_txn_kwargs (dict | None): Additional transaction kwargs passed to
544544
:meth:`~ape.api.networks.EcosystemAPI.create_transaction` for the
545545
:meth:`AccountAPI.set_delegate` method, such as ``gas``, ``max_fee``, or
@@ -556,8 +556,8 @@ def delegate_to(
556556
kwargs, see :class:`~ape.api.transactions.TransactionAPI`.
557557
558558
Returns:
559-
`:class:~ape.contracts.ContractInstance`:
560-
The contract instance of this account with the interface of `contract`.
559+
:class:`~ape.contracts.ContractInstance`:
560+
The contract instance of this account with the interface of ``contract``.
561561
"""
562562
set_txn_kwargs = {**txn_kwargs, **(set_txn_kwargs or {})}
563563
existing_delegate = self.delegate

src/ape/managers/chain.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -832,9 +832,7 @@ def get_block_at(
832832
"""
833833
Search for a block closest to time ``time``.
834834
835-
```{important}
836-
This method returns the closest block at or after ``time``.
837-
```
835+
**IMPORTANT**: This method returns the closest block at or after ``time``.
838836
839837
Args:
840838
time: (datetime | int): Time of block to search for.
@@ -843,7 +841,7 @@ def get_block_at(
843841
Defaults to the configured block time for this chain.
844842
845843
Returns:
846-
(~:class:`BlockAPI`): The first block mined at or after ``time`` .
844+
:class:`~ape.api.providers.BlockAPI`: The first block mined at or after ``time``.
847845
"""
848846

849847
if isinstance(time, datetime):

src/ape_pm/dependency.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class GithubDependency(DependencyAPI):
139139

140140
scheme: str = "https"
141141
"""
142-
Either HTTPS or SSH; only used with `ref:`.
142+
Either HTTPS or SSH; only used with ``ref``.
143143
"""
144144

145145
# Exists as property so can be changed for testing.

0 commit comments

Comments
 (0)