Skip to content

docs: update mention of ignores #544

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.

Sign up for GitHub

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

Merged
henryiii merged 3 commits into from
Feb 4, 2025
Merged

docs: update mention of ignores #544

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2a1164
docs: update mention of ignores
henryiii Feb 4, 2025
d8b0a19
Update README.md
henryiii Feb 4, 2025
b8c2213
style: pre-commit fixes
pre-commit-ci[bot] Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ mark checks as ignored.

For example, `GH101` expects all your action files to have a nice `name:` field.
If you are happy with the file-based names you see in CI, you should feel free
to simply ignore this check (just visually ignore it for the moment, a way to
specify ignored checks will likely be added eventually).
to simply ignore this check (you can specify ignored checks in pyproject.toml or
by passing args to repo-review, see the [repo-review docs][repo-review]).
Copy link
Copy Markdown
Contributor

@neutrinoceros neutrinoceros Feb 4, 2025

Choose a reason for hiding this comment

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

I think I would also link https://repo-review.readthedocs.io/en/latest/intro.html#configuring and/or https://repo-review.readthedocs.io/en/latest/cli.html


All checks are mentioned at least in some way in the [Scientific-Python
Development Guide][]. You should read that first - if you are not attempting to
Expand Down