Skip to content

Commit 9af5f47

Browse files
author
Hironori Yamamoto
committed
docs: add missing paramter
1 parent f8432e7 commit 9af5f47

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/mypy_plugin.rst

+14
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,17 @@ Mypy plugin checks TaskOnKart generic types.
6464
str_task=StrTask(), # mypy ok
6565
int_task=StrTask(), # mypy error: Argument "int_task" to "StrTask" has incompatible type "StrTask"; expected "TaskOnKart[int]
6666
)
67+
68+
Configurations (only pyproject.toml)
69+
-----------------------------------
70+
71+
You can configure the Mypy plugin using the ``pyproject.toml`` file.
72+
The following options are available:
73+
74+
``[tool.gokart-mypy]``
75+
Configuration section for gokart-mypy type checking settings.
76+
77+
``disallow_missing_parameters = true``
78+
If true, Mypy will raise an error if a task is missing required parameters.
79+
This configuration causes an error when the parameters set by `luigi.Config()`
80+
Default: ``false``

0 commit comments

Comments
 (0)