Require mypy extension

MaddyGuthridge · Jan 30, 2022 · 870fe65 · 870fe65
1 parent ab408f9
commit 870fe65
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -8,7 +8,8 @@
 		"ms-python.python",
 		"streetsidesoftware.code-spell-checker",
 		"njpwerner.autodocstring",
-		"kevinrose.vsc-python-indent"
+		"kevinrose.vsc-python-indent",
+		"matangover.mypy"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": [

diff --git a/include/__init__.py b/include/__init__.py
@@ -2,7 +2,10 @@
 include
 
 Initialise substitute modules to add them to the path variable, so that they
-can be imported normally
+can be imported normally.
+
+WARNING: The substitute modules aren't complete replacements, and should only
+be used for purposes that have no effect at runtime, such as type checking.
 """
 
 import sys

diff --git a/plugs/plugin.py b/plugs/plugin.py
@@ -1,7 +1,8 @@
 """
 plugins > plugin
 
-Contains the definition of the Plugin base class
+Contains the definition of the Plugin base class, and its two main types
+StandardPlugin and SpecialPlugin.
 """
 
 from common.util.apifixes import PluginIndex