summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorThomas Wiest <twiest@redhat.com>2015-06-03 14:38:10 -0400
committerThomas Wiest <twiest@redhat.com>2015-06-03 14:42:53 -0400
commit768c91b58822b41b44203c930d10a6fdc5058674 (patch)
treec3104085c950aca76f988536d1c3c15bc406759e /docs
parent433e3c77adf99cfaa5d6b8f94d2f0065f187b0fc (diff)
downloadopenshift-768c91b58822b41b44203c930d10a6fdc5058674.tar.gz
openshift-768c91b58822b41b44203c930d10a6fdc5058674.tar.bz2
openshift-768c91b58822b41b44203c930d10a6fdc5058674.tar.xz
openshift-768c91b58822b41b44203c930d10a6fdc5058674.zip
Added 'stylistic exception' to the best practices guide.
Diffstat (limited to 'docs')
-rw-r--r--docs/best_practices_guide.adoc1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/best_practices_guide.adoc b/docs/best_practices_guide.adoc
index 301c6ccda..af1acd94f 100644
--- a/docs/best_practices_guide.adoc
+++ b/docs/best_practices_guide.adoc
@@ -50,6 +50,7 @@ Instead, http://docs.pylint.org/faq.html#is-it-possible-to-locally-disable-a-par
.Exceptions:
1. When PyLint fails because of a dependency that can't be installed on the build bot
1. When PyLint fails because of including a module that is outside of control (like Ansible)
+1. When PyLint fails, but the code makes more sense the way it is formatted (stylistic exception). For this exception, the description of the PyLint disable MUST state why the code is more clear, AND the person reviewing the PR will decide if they agree or not. The reviewer may reject the PR if they disagree with the reason for the disable.
'''
[cols="2v,v"]