Skip to content

Commit

Permalink
docs: update mention of ignores (#544)
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii authored Feb 4, 2025
1 parent 3879831 commit 1e0b5d6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,9 @@ 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 configuring]).

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 Expand Up @@ -362,6 +363,7 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
<!-- [[[end]]] -->

[repo-review]: https://repo-review.readthedocs.io
[repo-review configuring]: https://repo-review.readthedocs.io/en/latest/intro.html#configuring
[scientific-python development guide]: https://learn.scientific-python.org/development
[scientific-python/cookie]: https://github.com/scientific-python/cookie
[scikit-hep]: https://scikit-hep.org
Expand Down

0 comments on commit 1e0b5d6

Please sign in to comment.