Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: Refer to PyTroll coding guidelines #659

Merged
merged 1 commit into from
Mar 18, 2019
Merged

DOC: Refer to PyTroll coding guidelines #659

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions doc/source/dev_guide/index.rst
View file
Open in desktop
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