Skip to content
Snippets Groups Projects
Commit a5c670f4 authored by Daniel CARRON's avatar Daniel CARRON :b:
Browse files

[doc] Disable RT03 check due do type aliasing issues in sphinx

parent bb828de9
No related branches found
No related tags found
1 merge request!15Update documentation
Pipeline #83881 canceled
......@@ -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.
]
......
......@@ -91,7 +91,6 @@ def run_powermetrics(
Returns
-------
data
A dictionary containing the GPU information.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment