summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorThomas Wiest <twiest@users.noreply.github.com>2015-06-04 09:58:48 -0400
committerThomas Wiest <twiest@users.noreply.github.com>2015-06-04 09:58:48 -0400
commitf906869478dee3f471d1a4f0908845c763c1ebfa (patch)
treeba6d2ffe2a24ae9c16ff719385cb5142728ff261 /docs
parent6487439922fddec52536fdbb84365aa7075bb53d (diff)
parent768c91b58822b41b44203c930d10a6fdc5058674 (diff)
downloadopenshift-f906869478dee3f471d1a4f0908845c763c1ebfa.tar.gz
openshift-f906869478dee3f471d1a4f0908845c763c1ebfa.tar.bz2
openshift-f906869478dee3f471d1a4f0908845c763c1ebfa.tar.xz
openshift-f906869478dee3f471d1a4f0908845c763c1ebfa.zip
Merge pull request #258 from twiest/pr
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 14bd0bb53..2768059b3 100644
--- a/docs/best_practices_guide.adoc
+++ b/docs/best_practices_guide.adoc
@@ -49,6 +49,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"]