EliAndrewC / sideboard

BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

Decide and enforce line length #30

Closed ftobia closed 8 years ago

ftobia commented 10 years ago

Lines should have a maximum length and Rob wants it to be enforce e.g. by a pep8 check. Per PEP8 (http://legacy.python.org/dev/peps/pep-0008/#maximum-line-length), 79 characters is preferred but 99 is acceptable if the team agrees. I know that Eli prefers a longer line length. I didn't realize this but apparently PEP-8 says comments and docstrings should be 72 character max no matter what. I can't imagine we'll be strict about that sort of thing though.

I think that Eli should decide, and then Rob will probably agree.

robdennis commented 10 years ago

I put out that 99 is a good compromise

On Mon, Mar 24, 2014 at 9:53 PM, Frank Tobia notifications@github.com wrote:

Lines should have a maximum length and Rob wants it to be enforce e.g. by a pep8 check. Per PEP8 (http://legacy.python.org/dev/peps/pep-0008/#maximum-line-length), 79 characters is preferred but 99 is acceptable if the team agrees. I know that Eli prefers a longer line length. I didn't realize this but apparently PEP-8 says comments and docstrings should be 72 character max no matter what. I can't imagine we'll be strict about that sort of thing though.

I think that Eli should decide, and then Rob will probably agree.

Reply to this email directly or view it on GitHub: https://github.com/appliedsec/sideboard/issues/30

EliAndrewC commented 10 years ago

I agree that 99 is a good compromise for most lines

You guys have heard my opinion on this before, but I'll reiterate it for the record: log and exception and print messages can be arbitrarily long since it's clear when glancing at the line what is happening and splitting them up consumes our precious vertical space in order to save our limitless horizontal space.

However, the benefit of having something enforce some linting conventions outweigh (IMO) the niceness of that kind of opinionated nuance, so I think having a tool enforce 99 character line lengths would be a good idea.

ftobia commented 10 years ago

It is decided that there will be a line length of 99, enforced through automated pep8 checks or some other mechanism.

robdennis commented 10 years ago

assigned to @ftobia