code_style.rst: a couple of tidyups
This commit is contained in:
parent
1ad1ba9e6a
commit
351cc35342
|
@ -1,5 +1,5 @@
|
||||||
Basically, PEP8
|
- Everything should comply with PEP8. Code should pass
|
||||||
|
``pep8 --max-line-length=100`` without any warnings.
|
||||||
- NEVER tabs. 4 spaces to indent.
|
- NEVER tabs. 4 spaces to indent.
|
||||||
- Max line width: 79 chars (with flexibility to overflow by a "few chars" if
|
- Max line width: 79 chars (with flexibility to overflow by a "few chars" if
|
||||||
the overflowing content is not semantically significant and avoids an
|
the overflowing content is not semantically significant and avoids an
|
||||||
|
@ -43,10 +43,10 @@ Basically, PEP8
|
||||||
together, or want to deliberately extend or preserve vertical/horizontal
|
together, or want to deliberately extend or preserve vertical/horizontal
|
||||||
space)
|
space)
|
||||||
|
|
||||||
Comments should follow the `google code style <http://google.github.io/styleguide/pyguide.html?showone=Comments#Comments>`_.
|
- Comments should follow the `google code style
|
||||||
This is so that we can generate documentation with
|
<http://google.github.io/styleguide/pyguide.html?showone=Comments#Comments>`_.
|
||||||
`sphinx <http://sphinxcontrib-napoleon.readthedocs.org/en/latest/>`_. See the
|
This is so that we can generate documentation with `sphinx
|
||||||
`examples <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_
|
<http://sphinxcontrib-napoleon.readthedocs.org/en/latest/>`_. See the
|
||||||
|
`examples
|
||||||
|
<http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_
|
||||||
in the sphinx documentation.
|
in the sphinx documentation.
|
||||||
|
|
||||||
Code should pass pep8 --max-line-length=100 without any warnings.
|
|
||||||
|
|
Loading…
Reference in New Issue