[Doc] vale ignores anchors of headers #53580
Conversation
Signed-off-by: fscnick <fscnick.dev@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Vale configuration to ignore Markdown header anchors that trigger false positives.
- Adds a
BlockIgnoresregex to.vale.inito skip header-anchor lines - Includes a comment explaining the new ignore rule
Comments suppressed due to low confidence (2)
.vale.ini:23
- [nitpick] Comments should follow sentence casing and be more descriptive. Consider updating this to: "# Ignore header anchor lines to bypass Vale rules."
# ignore the anchors of headers.
.vale.ini:24
- Wrap the regex pattern in quotes to ensure the .ini parser handles special characters correctly, for example:
BlockIgnores = "(?m)(^\([\w-]+\)=$)"BlockIgnores = (?m)(^\([\w-]+\)=$)
|
This pull request has been automatically marked as stale because it has not had You can always ask for help on our discussion forum or Ray's public slack channel. If you'd like to keep this open, just leave any comment, and the stale label will be removed. |
|
@fscnick Please sync master and ping me if you don't have merge permissions. |
Hi @dstrodtman, I have synced master, please help to merge it. |
Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Why are these changes needed?
The anchors of headers doesn't follow the vale rules. Add the
BlockIgnoresto bypass the rule on the anchors of headers.Here is the possible anchors found by grep but excluding
.ipynbwhich seems not support in vale.grep -nrI --exclude \*.ipynb ")=" doc/
Except the first line is from js in the comment, each anchor starts from the head of the line and ends by the end of the line. Thus, the pattern could be limited between those under multiline mode with match numbers, alphabets and dash within the parentheses. Attach the link for reference: https://regex101.com/r/9pHZdF/1
Related issue number
Closes #53516
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.