From da790826e99571c20399028d8c6866e54b4d8273 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Mon, 7 Jun 2021 12:33:12 +0100 Subject: [PATCH] Contributing: missing/incorrect docstrings will fail flake8 --- Contributing.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Contributing.md b/Contributing.md index 46f39d77..3cd30877 100644 --- a/Contributing.md +++ b/Contributing.md @@ -393,6 +393,9 @@ literals. Doc strings are preferred on all new modules, functions, classes, and methods, as they help others understand your code. We use the `sphinx` formatting style, which for pycharm users is the default. +Lack of docstrings, or them not passing some checks, *will* cause a flake8 +failure in our setup. + --- ## Comments