From a5c670f481ba2784091344d668525173a2ef40cb Mon Sep 17 00:00:00 2001
From: dcarron <daniel.carron@idiap.ch>
Date: Mon, 5 Feb 2024 10:21:54 +0100
Subject: [PATCH] [doc] Disable RT03 check due do type aliasing issues in
sphinx
---
pyproject.toml | 1 +
src/mednet/utils/resources.py | 1 -
2 files changed, 1 insertion(+), 1 deletion(-)
diff --git a/pyproject.toml b/pyproject.toml
index f2c14f40..5123f596 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -266,6 +266,7 @@ checks = [
"GL01", # Expects text to be on the line after the opening quotes but that is in direct opposition of the sphinx recommendations and conflicts with other pre-commit hooks.
"GL08", # Causes issues if we don't have a docstring at the top of the file. Disabling this might fail to catch actual missing docstrings.
"PR04", # numpydoc does not currently support PEP484 typehints, which we are using
+ "RT03", # Since sphinx is unable to understand type annotations we need to remove some types from 'Returns', which breaks this check.
"SA01", # We do not use Also sections
"SS06", # Summary will span multiple lines if too long because of reformatting by other hooks.
]
diff --git a/src/mednet/utils/resources.py b/src/mednet/utils/resources.py
index 8d95e121..184b9d39 100644
--- a/src/mednet/utils/resources.py
+++ b/src/mednet/utils/resources.py
@@ -91,7 +91,6 @@ def run_powermetrics(
Returns
-------
- data
A dictionary containing the GPU information.
"""
--
GitLab