zincware / MDSuite

A post-processing engine for particle simulations
https://mdsuite.readthedocs.io/
Eclipse Public License 2.0
36 stars 7 forks source link

update ruff excluded #578

Open PythonFZ opened 1 year ago

PythonFZ commented 1 year ago

After #567 we excluded as many as possible of ruffs errors. We should slowly bring them back. https://github.com/zincware/MDSuite/blob/0b85016999ac93caf52fa10ab7f46df11d7acaa9/pyproject.toml#L13-L20

SamTov commented 1 year ago

Is this not done with the closing of the PR?

SamTov commented 1 year ago

I'm finding that ruff ignore commands are inconsistent at best.

There is a case where if you exclude D401 it reports an error saying D401 does not exist. If you remove it, you get new ruff failures for D400 and D415. Once these are added back, it passes but fails in our CI due to error D401. Once D400 and D415 are in the ignore file, then one can ignore D401 without an error.

I guess we need to correct all possible errors before seeing what the issue is but sometimes it throws and error for something that doesn't exist, for example a missing full stop that is not missing.

PythonFZ commented 1 year ago

I think some of the errors might be related to inconsistent versions. I tried to fix some in #582 but eventually this will be resolved with #528

I agree, that not all ruff checks are necessary, but I think ending up with a small list of deliberately selected exclusions would be the ideal case?