search

WhitakerLab / scona

Code to analyse structural covariance brain networks using python.
https://whitakerlab.github.io/scona/
MIT License
68 stars 33 forks source link

PEP8 linting BrainNetworksInPython #70

Open rmarkello opened 6 years ago

rmarkello commented 6 years ago

I noticed yesterday when going through some of the code in BrainNetworksInPython that it could potentially use some linting to align with Python's PEP8 standards. Thankfully, tools like Atom have add-on packages that make this process much easier to do!

I was wondering if you would be amenable to my opening a PR aimed at linting the codebase a bit? I actually use the aforementioned package (linter-flake8) myself, and really like / recommend it. Indeed, while I may be a bit biased, I personally find that linted code is generally much nicer to read and easier to interpret—which will hopefully mean that new contributors find it easier to get involved.

Let me know if you think this would be of interest! :slightly_smiling_face:

KirstieJane commented 6 years ago

Hi @rmarkello! I think @islast had the day off today, and she might have some thoughts, but I’m pretty confident that this seems very useful, and I’m definitely sure that we’d welcome a pull request if it’s easy to do!

From my point of view, we’ve passed what I know about writing code (this makes me feel old and busy) so if your PR had an update to the CONTRIBUTING.md file that explained what would be expected for future contributors that would be 🔥🔥🔥

Thank you!!

Islast commented 6 years ago

Ah, sorry I missed this. Linting has been on the to do list for a while without me getting around to it, so I would be delighted if you want to open a pull request! :sparkles: You're absolutely right that it makes things easier for new contributors. I agree with @KirstieJane that it is worth updating the contributing docs to explain this, but don't feel that this is your responsibility! Someone else will update the docs if you don't :hibiscus:

Islast commented 6 years ago

This is addressed (at least for the core BrainNetworksInPython packages) in #74