Merge pull request #1310 from PythonCoderAS/add-disclaimers

Add more documentation info to the static check tool

setup.py

@@ -62,7 +62,7 @@
     license="Simplified BSD License",
     long_description=README,
     package_data={"": ["LICENSE.txt"], PACKAGE_NAME: ["*.ini"]},
-    packages=find_packages(exclude=["tests", "tests.*"]),
+    packages=find_packages(exclude=["tests", "tests.*", "tools", "tools.*"]),
     url="https://praw.readthedocs.org/",
     version=VERSION,
 )

tools/static_word_checks.py

@@ -108,6 +108,18 @@ def run_checks(self) -> bool:
 
         It runs the checks located in the ``self.full_file_checks`` and
         ``self.line_checks`` lists, with full file checks being run first.
+
+        Full-file checks are checks that can also fix the errors they find,
+        while the line checks can just warn about found errors.
+
+        * Full file checks:
+
+           * :meth:`.check_for_code_statement`
+           * :meth:`.check_for_double_syntax`
+
+        * Line checks
+
+           * :meth:`.check_for_noreturn`
         """
         status = True
         directory = os.path.abspath(os.path.join(__file__, "..", "..", "praw"))