Hi all,

I would like to discuss our style guides, specifically regarding the style
guide for the Python part of OCW.

Currently our style guide is effectively PEP-8 + camelCase variable names +
slightly longer line lengths.

I propose that we switch to plain PEP-8. Our compliance is fairly terrible
either way and since we're already going through a large refactoring I
don't see losing those few points of compliance as that big of an issue.

Following the Python communities standard makes it easier for developers to
jump into the project and it keeps our code in line with the rest of the
Python that we use. We also don't need a custom pylint config file. The
linting documentation is now simply "run pylint".

--

I ran pylint over the toolkit with and without our config.

With (This is our CamelCase version of Pep8) – 3.41/10

Without (This is PEP8) – 2.27/10


Thoughts?

-- Joyce

Reply via email to