Check for backtick-quoted shortcut links in CI#16114
Merged
MichaReiser merged 2 commits intoastral-sh:mainfrom Feb 14, 2025
Merged
Check for backtick-quoted shortcut links in CI#16114MichaReiser merged 2 commits intoastral-sh:mainfrom
MichaReiser merged 2 commits intoastral-sh:mainfrom
Conversation
InSyncWithFoo
force-pushed
the
docs-backticked-shortcut-links
branch
from
836774a to
1553f39
Compare
Contributor
|
MichaReiser
approved these changes
Feb 13, 2025
Member
MichaReiser
left a comment
MichaReiser
left a comment
There was a problem hiding this comment.
Thanks, this is great. I only have a few suggestions around commenting the code.
Contributor
Author
|
With this merged, I will be able to rest easy and monkeypatch the rest of the broken links client-side (not that I think I should, though) as they will be guaranteed to be option links. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Follow-up to #16035.
check_docs_formatted.pywill now report backtick-quoted shortcut links in rule documentation. It uses a regular expression to find them. Such a link:[, followed by`, then a "name" sequence of at least one non-backtick non-newline character, followed by another`, then ends with].[or a(.If the name is a known Ruff option name, that link is not considered a violation.
Test Plan
Manual.