docs: clean linting part of contributing guide of yamllint
The development flow guide mentioned several tools that needed to be installed in the PATH to run make lint. This change removes yamllint from that list now that makeyamllint has been made self-contained. With pylint the only remaining requirement, this also rewords the corresponding section for clarity. Signed-off-by: Michael Adam <obnox@samba.org>
This commit is contained in:
1 parent
f5d7004d22
commit
12cf909acd
1 file changed
+6
-6
@@ -256,13 +256,13 @@ Common cases that may need tests:
|
||||
|
||||
## Linting
|
||||
|
||||
Run `make lint` to run all linters. This will require the following CLI tools to be installed on the system:
|
||||
Run `make lint` to run several linters. This will require
|
||||
the [pylint](https://www.pylint.org/) CLI tool to be installed on the system in the PATH
|
||||
|
||||
* [yamllint](https://www.yamllint.com/)
|
||||
* [pylint](https://www.pylint.org/)
|
||||
|
||||
Many of those tools are available via `brew` for MacOS or as Linux distribution packages.
|
||||
Otherwise refer to the respective project websites for installation instructions.
|
||||
pylint is available via `brew` for MacOS and as a distribution package
|
||||
for many Linux distributions. It can also be installed into the system
|
||||
or a python virtual environment (venv) with `pip`.
|
||||
Refer to the respective project website for more installation instructions.
|
||||
|
||||
!!! tip
|
||||
Run `make help` to see a list of all possible make targets
|
||||
|
||||
Reference in new issue
Block a user