Add styleguide to docs
Review Request #3456 - Created Feb. 12, 2016 and submitted
|Nick Howard (Twitter)|
|benjyw, jsirois, lahosken, stuhood, zundel|
This is a first pass at starting a style guide containing some of the common nitpicks from reviews.
I'd talked a little about this on Slack a couple weeks ago and thought I'd put up a short initial RB.
Generated the docs locally.
Drive by only, I don't intend to follow-through on this review.
Both this entry and the linting entry below should be obviated by the pre-existing https://github.com/pantsbuild/pants/blob/master/build-support/bin/pre-commit.sh and the docs here recommending install of the client side commit hook: http://pantsbuild.github.io/howto_contribute.html#getting-pants-source-code
The space-after # here, the 2 spaces and the 100 cols all could be covered by pants own pythonstyle checks if they were enabled. You put the effort in to whip up the doc, so as you see fit, but effort would be better spent turning on the automated checks it seems to me so that this doc could just focus on non-automated rules, biases and idioms. The only Ones I see in this doc currently are the comment period bit and preferring `.format`.