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

Document pre-commit #215

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document pre-commit #215

wants to merge 2 commits into from

Conversation

sbrugman
Copy link
Contributor

@sbrugman sbrugman commented Feb 23, 2024

Closes #213

@seddonym
Copy link
Owner

Thanks for this. There were a couple of issues raised #214 and #213, which made me wonder if we need to cover the problems raised by that other contributor. Any thoughts on that?

@sbrugman
Copy link
Contributor Author

Thanks for linking. I've made a separate PR to close the first issue and updated the docs message slightly. Should be good to go, but feel free to edit.

Copy link
Owner

@seddonym seddonym left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this!

I'd like to have this better documented in Import Linter, but to be honest I'm not completely clear on how precommit works and I'm not able to get this working myself in this way (problems with Python path, possibly the same as #214).

I'm a bit reluctant to merge without understanding better what's going on - if I can't support it for myself, how can I for others? Probably the best way to do that would be to have a brief pairing session to get these docs into shape, is that something you might have time for? If so feel free to reach out via email and we can find a time.


repos:
- repo: https://github.com/seddonym/import-linter
rev: v2.0
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am I correct in thinking this should be the latest version of Import Linter?

It would be good if this could be pulled in dynamically somehow from the release variable defined in docs/conf.py. I tried to figure out how to do this for about ten minutes, not sure how easy this would be. How's your Sphinx?

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

Successfully merging this pull request may close these issues.

Add pre-commit documentation to docs
2 participants