saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Minor lint doc clarification, improvements

Browse source 
Refs https://github.com/saltstack/salt-pylint/issues/45
This commit is contained in:
Pedro Algarvio 2021-05-25 20:50:28 +01:00 • committed by Megan Wilhite
parent c3f43a3c38
commit 314edc830d
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/topics/development/conventions/style.rst
View file

@ -19,8 +19,11 @@ Linting
=======
Most Salt style conventions are codified in Salt's ``.pylintrc`` file.
Salt's pylint file has two dependencies: pylint_ and saltpylint_, however, linting should
be done using :ref:`nox <getting_set_up_for_tests>`.
Salt's linting has two major dependencies: pylint_ and saltpylint_, the full lint
requirements can be found under ``requirements/static/ci/lint.in`` and the pinned
requirements at ``requirements/static/ci/py3.<minor-version>/lint.txt``, however,
linting should be done using :ref:`nox <getting_set_up_for_tests>`, which is how
pull requests are checked.
.. code-block:: bash