README: Add anchors for rules and config options #491
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This will allow us to link to them directly.
jtojnar
commented
Sep 5, 2024
| @@ -58,76 +58,110 @@ If you'd like to do a PR we have development instructions `here <https://github. | |||
| List of warnings | |||
| ---------------- | |||
|
|
|||
| .. _B001: | |||
|
|
|||
| **B001**: Do not use bare ``except:``, it also catches unexpected events | |||
There was a problem hiding this comment.
We may also want to add a link to name so that users can obtain it without having to dig through the source code.
cooperlees
requested changes
Sep 5, 2024
There was a problem hiding this comment.
Thanks for this. This would be useful, I can see.
Is there any way we can make rstcheck happy here?
- Seems it's a known problem: Erronous info: Hyperlink target "my-reference-label" is not referenced. (sphinx) rstcheck/rstcheck-core#4
Can we look at adding the correct --ignore-directives to the pre-commit config please to not error rstcheck since this is a known problem.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will allow us to link to them directly.
Using the syntax from https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#use-a-custom-anchor
Example: https://github.com/jtojnar/flake8-bugbear/tree/readme-anchors#user-content-b950