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

✨ Add ability to use as stand-alone pre-commit hook #18

Merged
merged 9 commits into from
Jun 3, 2023

Conversation

s-weigand
Copy link
Contributor

Hey thanks for the cool project ❤️

Since I want to replace darglint in my pre-commit configs with your project (so tired of waiting on docs to lint) it would be nice to integrate it as a stand-alone hook rather than adding it to flake8 (my current workaround).

Especially since I want to replace flake8 with ruff anyway and darglint was the last big blocker.

.pre-commit-hooks.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@jsh9
Copy link
Owner

jsh9 commented Jun 2, 2023

Hi @s-weigand , thank you so much for creating this PR!

I added some comments, and merged in the latest changes in main for you.

You mentioned that you'd like to use pydoclint as a standalone hook rather than with flake8. That's fine, but please note that if you used it outside flake8, you wouldn't be able to use in-line omission (# noqa: DOCxxx): https://github.com/jsh9/pydoclint/blob/f2ffab506ad28bff9436e0d45f09b2228801026b/README.md

If you'd like to have both (pydoclint + ability to do in-line omission), here's a trick: create an environment with just pydoclint and then run flake8 --select=DOC <FILES>.

@s-weigand s-weigand requested a review from jsh9 June 3, 2023 10:13
@jsh9
Copy link
Owner

jsh9 commented Jun 3, 2023

Hi @s-weigand , thanks again! I'm merging this PR as "fixed".

@jsh9 jsh9 merged commit f938a5a into jsh9:main Jun 3, 2023
@s-weigand s-weigand deleted the pre-commit-hook branch June 3, 2023 12:16
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.

2 participants