summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorDull Bananas <dull.bananas0@gmail.com>2019-07-20 09:17:54 -0700
committerDull Bananas <dull.bananas0@gmail.com>2019-07-20 09:17:54 -0700
commitfb7efcf3f1cb1fb91214bfc6291090a7903f2a31 (patch)
treef33e1e49ab8cca352300e860a196ca930c7d3d1d /docs/dev
parent0b6c110a5cd65685c42702b27e2872ad9c234ab8 (diff)
downloadpython-requests-fb7efcf3f1cb1fb91214bfc6291090a7903f2a31.tar.gz
Add example of good code below example of bad code
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/contributing.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst
index d1171cb9..434dc565 100644
--- a/docs/dev/contributing.rst
+++ b/docs/dev/contributing.rst
@@ -130,7 +130,14 @@ the Requests codebase::
foo = long_function_name(var_one, var_two,
var_three, var_four)
-No. Just don't. Please.
+No. Just don't. Please. This is much better::
+
+ foo = long_function_name(
+ var_one,
+ var_two,
+ var_three,
+ var_four,
+ )
Docstrings are to follow the following syntaxes::