Skip to content

Commit

Permalink
Ignore DOC503 check in call_stub_method()
Browse files Browse the repository at this point in the history
We need the `noqa: DOC503` because `pydoclint` can't figure out that
`ApiClientError.from_grpc_error()` returns a `GrpcError` instance.

Signed-off-by: Leandro Lucarella <[email protected]>
  • Loading branch information
llucax committed Oct 3, 2024
1 parent fd3f3d2 commit e3ef0fb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/frequenz/client/base/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,9 @@ async def call_stub_method(
) -> StubOutT: ...


async def call_stub_method(
# We need the `noqa: DOC503` because `pydoclint` can't figure out that
# `ApiClientError.from_grpc_error()` returns a `GrpcError` instance.
async def call_stub_method( # noqa: DOC503
client: BaseApiClient[StubT],
stub_method: Callable[[], Awaitable[StubOutT]],
*,
Expand Down

0 comments on commit e3ef0fb

Please sign in to comment.