From 02fcbea6767fd4dfdd540f679dd4f0191fae3ef4 Mon Sep 17 00:00:00 2001 From: Jacob Pavlock Date: Wed, 22 Jul 2020 17:04:35 -0700 Subject: [PATCH] add google docstring convention to CONTRIBUTING.rst --- CONTRIBUTING.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e839599d4..d86c490b9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -215,9 +215,13 @@ There are a few coding conventions we use in beets: Style ----- -We follow `PEP 8 `__ 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 --------------