Skip to content

Commit c7b9991

Browse files
committed
Make darglint ignores markdown comments
This is so they don't show up in the generated documentation. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 7dbba78 commit c7b9991

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

src/frequenz/sdk/actor/_background_service.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ async def stop(self, msg: str | None = None) -> None:
142142
BaseExceptionGroup: If any of the tasks spawned by this service raised an
143143
exception.
144144
145-
# noqa: DAR401 rest
145+
[//]: # (# noqa: DAR401 rest)
146146
"""
147147
if not self._tasks:
148148
return

src/frequenz/sdk/actor/_resampling.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ async def _run(self) -> None:
111111
RuntimeError: If there is some unexpected error while resampling or
112112
handling requests.
113113
114-
# noqa: DAR401 error
114+
[//]: # (# noqa: DAR401 error)
115115
"""
116116
tasks_to_cancel: set[asyncio.Task[None]] = set()
117117
try:

src/frequenz/sdk/timeseries/_moving_window.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -259,21 +259,21 @@ def __len__(self) -> int:
259259
def __getitem__(self, key: SupportsIndex) -> float:
260260
"""See the main __getitem__ method.
261261
262-
# noqa: DAR101 key
262+
[//]: # (# noqa: DAR101 key)
263263
"""
264264

265265
@overload
266266
def __getitem__(self, key: datetime) -> float:
267267
"""See the main __getitem__ method.
268268
269-
# noqa: DAR101 key
269+
[//]: # (# noqa: DAR101 key)
270270
"""
271271

272272
@overload
273273
def __getitem__(self, key: slice) -> ArrayLike:
274274
"""See the main __getitem__ method.
275275
276-
# noqa: DAR101 key
276+
[//]: # (# noqa: DAR101 key)
277277
"""
278278

279279
def __getitem__(self, key: SupportsIndex | datetime | slice) -> float | ArrayLike:

src/frequenz/sdk/timeseries/_resampling.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -815,7 +815,7 @@ async def resample(self, timestamp: datetime) -> None:
815815
If the error is in the sink, the receiving part will continue
816816
working while this helper is alive.
817817
818-
# noqa: DAR401 recv_exception
818+
[//]: # (# noqa: DAR401 recv_exception)
819819
"""
820820
if self._receiving_task.done():
821821
if recv_exception := self._receiving_task.exception():

0 commit comments

Comments
 (0)