Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-25 01:53:31 +01:00
Code Issues Projects Releases Wiki Activity

add google docstring convention to CONTRIBUTING.rst

Browse source
This commit is contained in:
Jacob Pavlock 2020-07-22 17:04:35 -07:00 committed by jtpavlock
parent 019055c156
commit 02fcbea676
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.rst
View file

@ -215,9 +215,13 @@ There are a few coding conventions we use in beets:
Style
-----
We follow `PEP 8 <http://www.python.org/dev/peps/pep-0008/>`__ for
style. You can use ``tox -e lint`` to check your code for any style
errors.
We follow `PEP 8`_ and `google's docstring format`_.
You can use ``tox -e lint`` to check your code for any style errors.
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _google's docstring format: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
Handling Paths
--------------