Skip to content

Commit e6b6cf9

Browse files
authored
Merge pull request #341 from lsst-sqre/tickets/DM-47789
DM-47789: Make pagination docs friendlier to subclasses
2 parents d2e49a7 + 443199d commit e6b6cf9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

safir/src/safir/database/_pagination.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ def from_entry(cls, entry: E, *, reverse: bool = False) -> Self:
113113
114114
Builds a cursor to get the entries after the provided entry, or before
115115
the provided entry if ``reverse`` is set to `True`. When the cursor is
116-
later applied with `apply_cursor`, forward cursors (the default) must
117-
include the entry the cursor was based on. Reverse cursors must
118-
exclude the given entry and return data starting with the entry
119-
immediately previous.
116+
later applied with `~safir.database.PaginationCursor.apply_cursor`,
117+
forward cursors (the default) must include the entry the cursor was
118+
based on. Reverse cursors must exclude the given entry and return data
119+
starting with the entry immediately previous.
120120
121121
Parameters
122122
----------
@@ -127,7 +127,7 @@ def from_entry(cls, entry: E, *, reverse: bool = False) -> Self:
127127
128128
Returns
129129
-------
130-
PaginationCursor
130+
safir.database.PaginationCursor
131131
Requested cursor.
132132
"""
133133

@@ -148,7 +148,7 @@ def from_str(cls, cursor: str) -> Self:
148148
149149
Raises
150150
------
151-
InvalidCursorError
151+
safir.database.InvalidCursorError
152152
Raised if the cursor is invalid.
153153
"""
154154

0 commit comments

Comments
 (0)