Skip to content

Commit cc331cf

Browse files
docs: improve docstring
1 parent 9ddc094 commit cc331cf

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

hathor/indexes/address_index.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ def get_from_address(self, address: str) -> list[bytes]:
9595
def get_sorted_from_address(self, address: str, tx_start: Optional[BaseTransaction] = None) -> Iterable[bytes]:
9696
""" Get a sorted list of transaction hashes of an address
9797
98-
The parameter tx_start means the transaction from which the iterator will start, and it is used for pagination.
99-
When it's None it means that the iterator will start from the beginning.
98+
`tx_start` serves as a pagination marker, indicating the starting position for the iteration.
99+
When tx_start is None, the iteration begins from the initial element.
100100
"""
101101
raise NotImplementedError
102102

hathor/indexes/tx_group_index.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ def _get_from_key(self, key: KT) -> Iterable[bytes]:
5252
def _get_sorted_from_key(self, key: KT, tx_start: Optional[BaseTransaction] = None) -> Iterable[bytes]:
5353
"""Get all transactions that have a given key, sorted by timestamp.
5454
55-
The parameter tx_start means the transaction from which the iterator will start, and it is used for pagination.
56-
When it's None it means that the iterator will start from the beginning.
55+
`tx_start` serves as a pagination marker, indicating the starting position for the iteration.
56+
When tx_start is None, the iteration begins from the initial element.
5757
"""
5858
raise NotImplementedError
5959

0 commit comments

Comments
 (0)