summaryrefslogtreecommitdiff
path: root/doc/exts
diff options
context:
space:
mode:
authorDaniël van Noord <13665637+DanielNoord@users.noreply.github.com>2022-03-25 09:51:14 +0100
committerDaniël van Noord <13665637+DanielNoord@users.noreply.github.com>2022-03-25 10:02:06 +0100
commite73cfa840d47bee796795517c6d87906b81069d1 (patch)
tree80eb738478a0a643daf219b90c2fedbc6ba8b02e /doc/exts
parent3d95d39ad707cb26f003d180ed43e2670852bb96 (diff)
downloadpylint-git-e73cfa840d47bee796795517c6d87906b81069d1.tar.gz
Update configuration of pre-commit hooks and tools
Diffstat (limited to 'doc/exts')
-rwxr-xr-xdoc/exts/pylint_extensions.py9
-rwxr-xr-xdoc/exts/pylint_features.py7
2 files changed, 11 insertions, 5 deletions
diff --git a/doc/exts/pylint_extensions.py b/doc/exts/pylint_extensions.py
index da1b9ee2e..a8278c3b0 100755
--- a/doc/exts/pylint_extensions.py
+++ b/doc/exts/pylint_extensions.py
@@ -9,15 +9,18 @@
import os
import re
import sys
+from typing import Optional
import sphinx
+from sphinx.application import Sphinx
from pylint.constants import MAIN_CHECKER_NAME
from pylint.lint import PyLinter
from pylint.utils import get_rst_title
-def builder_inited(app):
+# pylint: disable-next=unused-argument
+def builder_inited(app: Optional[Sphinx]) -> None:
"""Output full documentation in ReST format for all extension modules."""
# PACKAGE/docs/exts/pylint_extensions.py --> PACKAGE/
base_path = os.path.dirname(
@@ -45,7 +48,7 @@ def builder_inited(app):
extensions_doc = os.path.join(
base_path, "doc", "technical_reference", "extensions.rst"
)
- with open(extensions_doc, "w") as stream:
+ with open(extensions_doc, "w", encoding="utf-8") as stream:
stream.write(
get_rst_title("Optional Pylint checkers in the extensions module", "=")
)
@@ -84,7 +87,7 @@ def get_plugins_info(linter, doc_files):
doc = ""
doc_file = doc_files.get(module)
if doc_file:
- with open(doc_file) as f:
+ with open(doc_file, encoding="utf-8") as f:
doc = f.read()
try:
by_checker[checker]["checker"] = checker
diff --git a/doc/exts/pylint_features.py b/doc/exts/pylint_features.py
index a60510224..ad0aa4a13 100755
--- a/doc/exts/pylint_features.py
+++ b/doc/exts/pylint_features.py
@@ -7,14 +7,17 @@
"""Script used to generate the features file before building the actual documentation."""
import os
+from typing import Optional
import sphinx
+from sphinx.application import Sphinx
from pylint.lint import PyLinter
from pylint.utils import print_full_documentation
-def builder_inited(app):
+# pylint: disable-next=unused-argument
+def builder_inited(app: Optional[Sphinx]) -> None:
# PACKAGE/docs/exts/pylint_extensions.py --> PACKAGE/
base_path = os.path.dirname(
os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -22,7 +25,7 @@ def builder_inited(app):
linter = PyLinter()
linter.load_default_plugins()
features = os.path.join(base_path, "doc", "technical_reference", "features.rst")
- with open(features, "w") as stream:
+ with open(features, "w", encoding="utf-8") as stream:
stream.write("Pylint features\n")
stream.write("===============\n\n")
stream.write(".. generated by pylint --full-documentation\n\n")