Emphasize PEP8 (non-TF spacing) compliance in README.md #310
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
split out from #308 |
seanpmorgan
reviewed
Jun 20, 2019
STYLE_GUIDE.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
Thanks for adding this... clarification is certainly needed. Could you modify this slightly to say that we follow "the conventions of the TensorFlow library, but choose to format our code using PEP8 guidelines" or something along those lines?
My first read of this was it was a bit back and forth on which guide to use. Though we format with PEP8 and use the conventions for building upon the library.
There was a problem hiding this comment.
sure, makes sense. see if the updated commit (cea8962) reads more cleanly
mels630
force-pushed
the
minor_doc_split/style_guide
branch
from
7c72d09
to
ec33a0b
Compare
mels630
force-pushed
the
minor_doc_split/style_guide
branch
from
ec33a0b
to
cea8962
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.