Closed janosh closed 2 years ago
@ardunn I see this conflicts with an existing lint script though not where exactly since scripts/linting_check.sh
doesn't report offending line numbers. The hooks added in 6d112fc are a superset of those run in scripts/linting_check.sh
so I guess we could just add pre-commit.ci to this repo and remove scripts/linting_check.sh
?
@janosh for sanity sake it might be easiest to just nuke this branch and then copy over the pre-commit hooks on your side manually. Then we can make a minimal new PR and see the actual changes as intended (rather than a bunch of doc changes which are hard to sift through!!)
Also, for reference I don't really care about how rebuild docs
looks as long as automatic linting doesn't really inhibit the readability of it. Some of the lines (e.g., automated table creation) will look super weird and be hard to read if they're split up as per typical linting. For this reason, unless the line lengths are really long, I'd recommend not linting rebuild_docs.py
unless there is some other major advantage I'm not seeing.
@ardunn Sure thing, I resolved the merge conflicts and excluded rebuild_docs.py
in .pre-commit-config.yaml
. I also dropped the pre-commit run --all-files
commit that applied all the auto changes. Hopefully, that makes it easier to review.
Sure, is it ready to review now? Or if not just tag me when it is
Yes, I think it's good to go.
Actually, hold on. All the HTML files under docs_src/static/
are not supposed to be in this PR.
There we go, now it's ready for review.
matminer
file hash issue:@janosh Ok! I have pushed some commits to try to fix the hash issue on matminer. I think that is the most natural place to fix it. The downside is that this hash problem will continue until the next release of matminer when I will update the matbench requirements...
Does this PR need to wait until then?
No, I can just merge in now
Split out of #126 for clarity.
Includes the usual hooks also used by pymatgen and other MP repos (except for
pylint
andmypy
).Reasons:
mypy
doesn't make much sense here without type annotationspylint
is a bit slow and doesn't play well with thepre-commit
framework