From ec33a0b2e8eff9c4ba53e94a2e691a09945a8004 Mon Sep 17 00:00:00 2001 From: Matt Elsey Date: Thu, 20 Jun 2019 09:29:03 -0700 Subject: [PATCH] Emphasize PEP8 (non-TF spacing) compliance in README.md --- STYLE_GUIDE.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index ea338d9cf5..54dd69f381 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -43,3 +43,6 @@ foo._protected_member #### TensorFlow Conventions Follow the guidance in the [TensorFlow Style Guide - Conventions](https://www.tensorflow.org/community/contribute/code_style#tensorflow_conventions_and_special_uses). + +Please note that Addons follows these conventions but _not_ the entirety of the [TensorFlow Style Guide](https://www.tensorflow.org/community/contribute/code_style). +In particular, as stated above, Python code should conform to [PEP8](https://www.python.org/dev/peps/pep-0008/) _without_ the Tensorflow spacing exception.