datasnakes / OrthoEvolution

An easy to use and comprehensive python package which aids in the analysis and visualization of orthologous genes. 🐵
https://orthoevolution.readthedocs.io/en/master/
29 stars 4 forks source link

Agree on a line length for our package. #102

Closed grabear closed 6 years ago

grabear commented 6 years ago

PEP8 convention calls for a line length of ~80 characters:

Limit all lines to a maximum of 79 characters.

For flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters.

However, I like something a bit longer. Around 120 characters. I don't mind doing 120 for both code and docstrings, but I can do 120 for code and 72 for docstrings.

Let me know if you prefer something different @sdhutchins.

grabear commented 6 years ago

We can add this to the contributing file.

81

sdhutchins commented 6 years ago

I'm a pep8 fan so... :grimacing: :grin:

grabear commented 6 years ago

Can you meet me half-way at 100 characters?? :sweat_smile:

Some teams strongly prefer a longer line length. For code maintained exclusively or primarily by a team that can reach agreement on this issue, it is okay to increase the nominal line length from 80 to 100 characters (effectively increasing the maximum length to 99 characters), provided that comments and docstrings are still wrapped at 72 characters.

sdhutchins commented 6 years ago

How about this...

If you can, < 80, but if not, no greater than 100?

Spindel commented 6 years ago

Try adding:

[flake8]
max-line-length = 100

to your setup.cfg then

sdhutchins commented 6 years ago

Thanks for that @Spindel

grabear commented 6 years ago

Nice. Thanks @Spindel for checking out our repository.

sdhutchins commented 6 years ago

Addressed with commit 4b7b1d86521e5ef6ec1657bea9aeeddb27016e4e