diff --git a/README.rst b/README.rst index f871082..19206a4 100644 --- a/README.rst +++ b/README.rst @@ -76,7 +76,7 @@ Configuration * - ``follow-imports`` - ``pylsp.plugins.pylsp_mypy.follow-imports`` - ``normal``, ``silent``, ``skip`` or ``error`` - - ``mypy`` **parameter** ``follow-imports``. In ``mypy`` this is ``normal`` by default. We set it ``silent``, to sort out unwanted results. This can cause cash invalidation if you also run ``mypy`` in other ways. Setting this to ``normal`` avoids this at the cost of a small performance penalty. + - ``mypy`` **parameter** ``follow-imports``. In ``mypy`` this is ``normal`` by default. We set it ``silent``, to sort out unwanted results. This can cause cache invalidation if you also run ``mypy`` in other ways. Setting this to ``normal`` avoids this at the cost of a small performance penalty. - ``silent`` Using a ``pyproject.toml`` for configuration, which is in fact the preferred way, your configuration could look like this: @@ -90,7 +90,7 @@ Using a ``pyproject.toml`` for configuration, which is in fact the preferred way exclude = ["tests/*"] A ``pyproject.toml`` does not conflict with the legacy config file (deprecated) given that it does not contain a ``pylsp-mypy`` section. The following explanation uses the syntax of the legacy config file (deprecated). However, all these options also apply to the ``pyproject.toml`` configuration (note the lowercase bools). -Depending on your editor, the configuration (found in a file called pylsp-mypy.cfg in your workspace or a parent directory) should be roughly like this for a standard configuration: +Depending on your editor, the configuration (found in a file called ``pylsp-mypy.cfg`` in your workspace or a parent directory) should be roughly like this for a standard configuration: ::