-
Notifications
You must be signed in to change notification settings - Fork 15
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
Documenting tool integration #104
Conversation
docs/how_to_config.md
Outdated
``` | ||
|
||
If you've already specified all the configuration options in a config file, | ||
here is how to cite them in `.pre-commit-config.yaml`: | ||
|
||
```yaml | ||
# Option 1: with native tool | ||
- repo: https://github.com/jsh9/pydoclint | ||
rev: <latest_tag> | ||
hooks: | ||
- id: pydoclint | ||
args: | ||
- "--config=pyproject.toml" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a total expert in specifying args in pre-commit. Do you think the "official" way is to include quotes (like in this line) or not?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quotes aren't necessary here cuz there's no special or reserved chars.
https://pre-commit.com/#passing-arguments-to-hooks
The official docs don't have quotes for args
. I will remove the quotes here for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Committed, let me know if you like quoted style better 👌
@jsh9 could I bump on this? |
Hi @jamesbraza , I'm sorry I've been quite busy over the past few weeks. I'll take a look in the next few days. |
Hi @jamesbraza , I still haven't got a chance to work on it. I'll try to finish this within 1-2 weeks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jsh9 thanks for the great feedback, it's now ready for your review
Upstreams knowledge from #96
Resolves #101
pre-commit-config.yaml
forflake8
-plugin, with configsAlso documents how to configure
ruff
compatibility usingexternal