Skip to content

Commit 1e0b5d6

Browse files
authored
docs: update mention of ignores (#544)
1 parent 3879831 commit 1e0b5d6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,9 @@ mark checks as ignored.
233233

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

239240
All checks are mentioned at least in some way in the [Scientific-Python
240241
Development Guide][]. You should read that first - if you are not attempting to
@@ -362,6 +363,7 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
362363
<!-- [[[end]]] -->
363364

364365
[repo-review]: https://repo-review.readthedocs.io
366+
[repo-review configuring]: https://repo-review.readthedocs.io/en/latest/intro.html#configuring
365367
[scientific-python development guide]: https://learn.scientific-python.org/development
366368
[scientific-python/cookie]: https://github.com/scientific-python/cookie
367369
[scikit-hep]: https://scikit-hep.org

0 commit comments

Comments
 (0)