From 870fe65dd59ae6091c95a2c8a413818970d20d56 Mon Sep 17 00:00:00 2001 From: Miguel Guthridge Date: Sun, 30 Jan 2022 19:20:24 +1100 Subject: [PATCH] Require mypy extension --- .vscode/extensions.json | 3 ++- include/__init__.py | 5 ++++- plugs/plugin.py | 3 ++- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index ef7b5af9..3870c0bb 100644 --- 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 index 82930650..de1c39a7 100644 --- 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 index fb395c85..75c151f0 100644 --- 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