Skip to content

Commit dee6a6c

Browse files
committed
Additional wording in README
1 parent 188e7d0 commit dee6a6c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Install into the same virtualenv as python-lsp-server itself.
2323

2424
Configuration
2525
-------------
26+
``pylsp-mypy`` supports the use of ``pyproject.toml`` for configuration. It can also be configuered using configs provided to the LSP server. The configuration keys are listed in the following.
2627

2728
.. list-table:: Configuration
2829
:header-rows: 1
@@ -40,12 +41,12 @@ Configuration
4041
* - ``dmypy``
4142
- ``pylsp.plugins.pylsp_mypy.dmypy``
4243
- ``boolean``
43-
- **Executes via ``dmypy run`` rather than ``mypy``**. This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
44+
- **Executes via** ``dmypy run`` **rather than** ``mypy``. This uses the ``dmypy`` daemon and may dramatically improve the responsiveness of the ``pylsp`` server, however this currently does not work in ``live_mode``. Enabling this disables ``live_mode``, even for conflicting configs.
4445
- false
4546
* - ``strict``
4647
- ``pylsp.plugins.pylsp_mypy.strict``
4748
- ``boolean``
48-
- **Refers to the ``strict`` option of ``mypy``**. This option often is too strict to be useful.
49+
- **Refers to the** ``strict`` **option of** ``mypy``. This option often is too strict to be useful.
4950
- false
5051
* - ``overrides``
5152
- ``pylsp.plugins.pylsp_mypy.overrides``
@@ -73,7 +74,7 @@ Configuration
7374
- **A list of regular expressions which should be ignored**. The ``mypy`` runner wil not be invoked when a document path is matched by one of the expressions. Note that this differs from the ``exclude`` directive of a ``mypy`` config which is only used for recursively discovering files when mypy is invoked on a whole directory. For both windows or unix platforms you should use forward slashes (``/``) to indicate paths.
7475
- ``[]``
7576

76-
This project supports the use of ``pyproject.toml`` for configuration. It is in fact the preferred way. Using that your configuration could look like this:
77+
Using a ``pyproject.toml`` for configuration, which is in fact the preferred way, your configuration could look like this:
7778

7879
::
7980

@@ -83,7 +84,7 @@ This project supports the use of ``pyproject.toml`` for configuration. It is in
8384
strict = true
8485
exclude = ["tests/*"]
8586

86-
A ``pyproject.toml`` does not conflict with the legacy config file given that it does not contain a ``pylsp-mypy`` section. The following explanation uses the syntax of the legacy config file. However, all these options also apply to the ``pyproject.toml`` configuration (note the lowercase bools).
87+
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).
8788
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:
8889

8990
::

0 commit comments

Comments
 (0)