-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document linting with darker #247
Comments
Linting is, in my opinion, a very personal thing. We added darker because we got tired of writing comments about pep8, but I'm not sure it would be where I would point folks to necessarily? I generally just tell folks to use whatever works with their IDE as long as they only fix things in the stuff they touch. |
but it would still be a useful addition, right? Like "...This is not essential, but if you want your darker action to pass, here's how to check your code against it..." |
I think I'll let the other @MDAnalysis/coredevs chime in here - I personally don't know to what extent I really want to recommend |
My assumption is that our use of darker is some sort of trial for now. I don't really know what it will recommend and to what extent I am going to agree with it. With that in mind, it may indeed be useful to point people to the method to run the tool on their PR. It is frustrating to have to push to see the result of the CI and being able to run the tool locally can save some frustration. So 👍 for documenting our use of darker, but with warnings and caveats around the doc. |
Darker linting was added in this PR.
I think this is pretty much the information a developer needs:
Install:
Usage (assuming we forked from
develop
branch):The text was updated successfully, but these errors were encountered: