Browse Source

pylint: disable missing-module-docstring selectively

Fabian Peter Hammerle 10 months ago
parent
commit
b7c4b6859d
7 changed files with 14 additions and 2 deletions
  1. 2 1
      .pylintrc
  2. 2 1
      setup.py
  3. 2 0
      tests/ashs_test.py
  4. 2 0
      tests/conftest.py
  5. 2 0
      tests/freesurfer_test.py
  6. 2 0
      tests/init_test.py
  7. 2 0
      tests/main_test.py

+ 2 - 1
.pylintrc

@@ -1,7 +1,8 @@
 [MESSAGES CONTROL]
 
 disable=bad-continuation, # black
-        missing-docstring
+        missing-class-docstring,
+        missing-function-docstring
 
 
 [SIMILARITIES]

+ 2 - 1
setup.py

@@ -11,7 +11,8 @@ setuptools.setup(
     use_scm_version={
         "write_to": os.path.join("freesurfer_volume_reader", "version.py"),
         # `version` triggers pylint C0103
-        "write_to_template": "__version__ = '{version}'\n",
+        "write_to_template": "# pylint: disable=missing-module-docstring\n"
+        + "__version__ = '{version}'\n",
     },
     description="Python script & library to read hippocampal subfield volumes"
     "computed by Freesurfer & ASHS",

+ 2 - 0
tests/ashs_test.py

@@ -1,3 +1,5 @@
+# pylint: disable=missing-module-docstring
+
 import os
 import re
 

+ 2 - 0
tests/conftest.py

@@ -1,3 +1,5 @@
+# pylint: disable=missing-module-docstring
+
 import os
 
 import pandas

+ 2 - 0
tests/freesurfer_test.py

@@ -1,3 +1,5 @@
+# pylint: disable=missing-module-docstring
+
 import os
 import re
 

+ 2 - 0
tests/init_test.py

@@ -1,3 +1,5 @@
+# pylint: disable=missing-module-docstring
+
 import pytest
 
 from freesurfer_volume_reader import (

+ 2 - 0
tests/main_test.py

@@ -1,3 +1,5 @@
+# pylint: disable=missing-module-docstring
+
 import io
 import os
 import subprocess