Skip to content

Commit

Permalink
DOC: Refer to PyTroll coding guidelines
Browse files Browse the repository at this point in the history
In the documentation Developer Guide, refer to the general PyTroll
coding guidelines.
  • Loading branch information
gerritholl committed Mar 14, 2019
1 parent ee02de0 commit a5e21ad
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions doc/source/dev_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@ at the pages listed below.
Coding guidelines
=================

SatPy tries to follow
`PEP8 <https://www.python.org/dev/peps/pep-0008/>`_ style guidelines for
all of its python code. We also try to limit lines of code to 80 characters
whenever possible and when it doesn't hurt readability. SatPy follows
`Google Style Docstrings <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_
for all code API documentation. When in doubt use the existing code as a
guide for how coding should be done.
SatPy is part of `PyTroll <http://pytroll.github.io/>`_,
and all code should follow the
`PyTroll coding guidelines and best
practices <http://pytroll.github.io/guidelines.html>`_.

SatPy currently supports Python 2.7 and 3.4+. All code should be written to
be compatible with these versions.
Expand Down

0 comments on commit a5e21ad

Please sign in to comment.