Repository navigation
Conversation
plzzwork
left a comment
There was a problem hiding this comment.
Py-flake8 and py-pylint are no longer tests for Submitty_test. These two have been changed to py-lint and py-format which run the ruff check and ruff format respectively. Lines 163 and 164 do not have twig-lint in front of the modifiers. Line 164 was not able to read the listed twig file. twig-line --show-deprecation worked fine. Both shell-lint and yaml-lint worked.
…ty/submitty.github.io into update-submitty-test-docs
You can add comments to specific lines! |
|
|
||
| __Minimum Version__: 3.8 | ||
|
|
||
| For Python, we use [flake8](http://flake8.pycqa.org/en/latest/) and [pylint](https://pylint.readthedocs.io/en/stable/) |
There was a problem hiding this comment.
@plzzwork this is an example of a comment corresponding to a line
Why is this Change Important & Necessary?
In Submitty/Submitty PR #13297, linting with ShellCheck was added to
submitty_test.In Submitty/Submitty PR #13302, linting for twig files was added to
submitty_test.In Submitty/Submitty PR #13301, linting for yaml / yml files was added to
submitty_test.In Submitty/Submitty PR #13299, we switched our python linter / formatter to ruff.
These new features needed to be documented in the Linting and Static Analysis instructions for developers.
What is the New Behavior?
New documentation has been added for developers about the new linting options.
What steps should a reviewer take to reproduce or test the bug or new feature?
Verify that all wording / instruction is correct and understandable.