Skip to content

Commit

Permalink
Docs: updates code quality links
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hammond authored and tobes committed Nov 20, 2012
1 parent 3abe61d commit 72d6421
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions doc/coding-standards.rst
Expand Up @@ -353,23 +353,32 @@ Example of a ckan.logic.action API docstring:

.. _Autodoc: http://sphinx.pocoo.org/ext/autodoc.html

Tools
-----

Running the `PEP 8 style guide checker`_ is good for checking adherence to `PEP
8`_ formatting. As mentioned above, only perform style clean-ups on master to
help avoid spurious merge conflicts.
Some Helpful Tools for Python Code Quality
------------------------------------------

There are various tools that can help you to check your Python code for PEP8
conformance and general code quality. We recommend using them.

* `pep8`_ checks your Python code against some of the style conventions in PEP
8. As mentioned above, only perform style clean-ups on master to help avoid
spurious merge conflicts.

`PyLint`_ is a useful tool for analysing python source code for errors and signs of poor quality.
* `pylint`_ analyzes Python source code looking for bugs and signs of poor
quality.

`pyflakes`_ is another useful tool for passive analysis of python source code.
There's also a `pyflakes vim plugin`_ which will highlight unused variables,
undeclared variables, syntax errors and unused imports.
* `pyflakes`_ also analyzes Python programs to detect errors.

.. _PEP 8 style guide checker: http://pypi.python.org/pypi/pep8
.. _PyLint: http://www.logilab.org/857
* `flake8`_ combines both pep8 and pyflakes into a single tool.

* `Syntastic`_ is a Vim plugin with support for flake8, pyflakes and pylint.

.. _pep8: http://pypi.python.org/pypi/pep8
.. _pylint: http://www.logilab.org/857
.. _pyflakes: http://pypi.python.org/pypi/pyflakes
.. _pyflakes vim plugin: http://www.vim.org/scripts/script.php?script_id=2441
.. _flake8: http://pypi.python.org/pypi/flake8
.. _Syntastic: https://github.com/scrooloose/syntastic


CKAN Code Areas
===============
Expand Down

0 comments on commit 72d6421

Please sign in to comment.