From 200b1b65fdf4600232ab39dc5863c2a76283454a Mon Sep 17 00:00:00 2001 From: "Bora M. Alper" Date: Sun, 11 Jun 2017 10:05:35 +0300 Subject: [PATCH] fixed formatting in CONTRIBTUING.rst --- CONTRIBUTING.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bdeb376..70f03fe 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -55,7 +55,8 @@ Python Coding Guidelines * Maximum line length is 120 characters. * Do not abbreviate variable names, unless the abbreviation is famous (even though it might be *obvious* in its code - context). For instance, `HTTP` is accepted but `_f` for *futures* and `p_` for *parent* are NOT. + context). For instance, `HTTP` is accepted, but `_f` for *futures* and `p_` for *parent* are NOT. + * A possible exception of this rule is to use shorter names in case of complex symbolic manipulation and/or operations, for instance in complex for-loops, functions etc. Shorter names would allow the programmer to follow the flow of the operations and logic behind the manipulation more easily and hence justified. But, comments are required