Skip to content

Commit b84e31c

Browse files
bboeclaude
andcommitted
Reword property docstrings for ruff property-docstring-starts-with-verb
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 0833eec commit b84e31c

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

prawcore/auth.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def _auth(self) -> tuple[str, str]:
2929

3030
@property
3131
def requestor(self) -> Requestor:
32-
"""Return the :class:`.Requestor` used to issue HTTP requests."""
32+
"""The :class:`.Requestor` used to issue HTTP requests."""
3333
return self._requestor
3434

3535
def __init__(
@@ -135,7 +135,7 @@ class BaseAuthorizer:
135135

136136
@property
137137
def authenticator(self) -> BaseAuthenticator:
138-
"""Return the :class:`.BaseAuthenticator` used to authenticate requests."""
138+
"""The :class:`.BaseAuthenticator` used to authenticate requests."""
139139
return self._authenticator
140140

141141
def __init__(self, *, authenticator: BaseAuthenticator) -> None:

prawcore/sessions.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,17 +154,17 @@ def _log_request(
154154

155155
@property
156156
def authorizer(self) -> BaseAuthorizer:
157-
"""Return the :class:`.BaseAuthorizer` used to authorize requests."""
157+
"""The :class:`.BaseAuthorizer` used to authorize requests."""
158158
return self._authorizer
159159

160160
@property
161161
def rate_limiter(self) -> RateLimiter:
162-
"""Return the :class:`.RateLimiter` that throttles requests."""
162+
"""The :class:`.RateLimiter` that throttles requests."""
163163
return self._rate_limiter
164164

165165
@property
166166
def requestor(self) -> Requestor:
167-
"""Return the :class:`.Requestor` used to issue HTTP requests."""
167+
"""The :class:`.Requestor` used to issue HTTP requests."""
168168
return self._authorizer.authenticator.requestor
169169

170170
def __enter__(self) -> Self:

0 commit comments

Comments
 (0)