github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Fix linter errors with invoke lint --fix

Browse source
This commit is contained in:
Justin Mayer 2025-07-09 09:15:40 +02:00
commit 95965459f2
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/contribute.rst
View file

@ -103,9 +103,14 @@ lines you changed conform to code style guidelines. You can check that via::
invoke lint
If style violations are found, many of them can be addressed automatically via::
invoke lint --fix
invoke format
If code style violations are found in lines you changed, correct those lines
and re-run the above lint command until they have all been fixed. You do not
need to address style violations, if any, for code lines you did not touch.
and re-run the ``invoke lint`` command until they have all been fixed. You do
not need to address style violations, if any, for code lines you did not touch.
After making your changes and running the tests, you may see a test failure
mentioning that "some generated files differ from the expected functional tests
@ -194,6 +199,7 @@ check for code style compliance via::
If style violations are found, many of them can be addressed automatically via::
invoke lint --fix
invoke format
If style violations are found even after running the above auto-formatters,