Skip to content
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

Invalid pylint options #139

Open
lilyminium opened this issue Nov 2, 2024 · 3 comments
Open

Invalid pylint options #139

lilyminium opened this issue Nov 2, 2024 · 3 comments

Comments

@lilyminium
Copy link
Member

There's a lot of pylint warnings in CI.

In general pylint is a bit of a headache. Not sure how other alternatives stack up -- flake8 or black?

@RMeli
Copy link
Member

RMeli commented Nov 2, 2024

Black doesn’t do linting, but I also find out that pylint is a bit too annoying with respect to flake8. I use black for automated formatting and flak8 for linting (with settings to work well with black).

@lilyminium
Copy link
Member Author

That seems like a good workflow @RMeli, I wonder if having some kind of opt-in/out for the black/flake8 options would be the best solution here. Since the core library is moving in this direction especially, IMO the cookiecutter should keep pace.

I'll fix pylint in the interim but unless anyone disagrees I'll follow whatever MDA core does.

@IAlibay
Copy link
Member

IAlibay commented Nov 11, 2024

One of the biggest issues with the MolSSI cookiecutter is that is just tries to do too many things.

My suggestion is to keep it simple - in many ways not providing anything is better than trying to provide everything.
Right now flake8 and isort are available via precommit but there's no real docummentation for it (at least nothing I can see in the rtd builds). Similar thing for pylint.

Switching to flake8/black is reasonable, as long as we are ok keeping up to date & having it well documented, otherwise we fall in the same cookiecutter issue of having things that new users are going to not be too sure what to do with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants