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

Documenting tool integration #104

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Documenting tool integration #104

merged 3 commits into from
Jan 29, 2024

Conversation

jamesbraza
Copy link
Contributor

@jamesbraza jamesbraza commented Nov 20, 2023

Upstreams knowledge from #96

  • That native mode doesn't support error codes

Resolves #101

  • Adds sample pre-commit-config.yaml for flake8-plugin, with configs

Also documents how to configure ruff compatibility using external

docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
```

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"
Copy link
Owner

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?

Copy link
Contributor Author

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

Copy link
Contributor Author

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 👌

docs/how_to_config.md Outdated Show resolved Hide resolved
@jamesbraza jamesbraza requested a review from jsh9 November 27, 2023 15:06
@jamesbraza
Copy link
Contributor Author

@jsh9 could I bump on this?

@jsh9
Copy link
Owner

jsh9 commented Dec 24, 2023

@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.

@jsh9
Copy link
Owner

jsh9 commented Jan 2, 2024

Hi @jamesbraza , I still haven't got a chance to work on it. I'll try to finish this within 1-2 weeks.

README.md Outdated Show resolved Hide resolved
docs/how_to_config.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/how_to_ignore.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@jamesbraza jamesbraza requested a review from jsh9 January 20, 2024 23:38
Copy link
Contributor Author

@jamesbraza jamesbraza left a 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

docs/how_to_ignore.md Show resolved Hide resolved
@jsh9 jsh9 merged commit 676847e into jsh9:main Jan 29, 2024
13 checks passed
@jamesbraza jamesbraza deleted the documenting-tooling-integration branch January 29, 2024 16:59
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.

Docs request: pre-commit config for flake8
2 participants