diff --git a/docs/contribute.rst b/docs/contribute.rst index 07cf998a..37b90e92 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -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,