Skip to content

Commit

Permalink
per #1974, updated coding standards section -- Removed links to codin…
Browse files Browse the repository at this point in the history
…g standards that we don't follow strictly and can cause confusion for new developers. Removed code analysis tool information to avoid having to keep information about external tools up-to-date and we don't strictly enforce using these tools in our development workflow.
  • Loading branch information
georgemccabe committed Jul 21, 2023
1 parent 7327a05 commit ff360ff
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/Contributors_Guide/coding_standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ Coding Standards
docstrings <https://www.python.org/dev/peps/pep-0257/>`_, and
`Sphinx <http://www.sphinx-doc.org/en/master/>`_ for documentation
* **NOTE: Please do not use f-strings in the run_metplus.py file so that the Python version check can notify the user of the incorrect version. Using Python 3.5 or earlier will output the SyntaxError from the f-string instead of the useful error message.**

Python code analysis tools like **pylint** can be used to check for errors and violations of PEP8 standards.

0 comments on commit ff360ff

Please sign in to comment.