[Internal] PRLint: Refactors regex failure comment format in prlint.yml#5893
Conversation
Updated the comment format for regex failure messages and examples in the PR lint workflow.
kushagraThapar
left a comment
There was a problem hiding this comment.
Nice cleanup — switching from > + <br /> to | is much more readable. Two small follow-ups I'd suggest folding into this PR, since they're in the same lines and would deliver the full "comment now renders cleanly on GitHub" outcome:
-
Drop the backslash escapes in
\"[Internal] Category: ...\". Backslash escapes (\") are only interpreted inside YAML double-quoted strings — in|(or>) block scalars they pass through literally, so the rendered comment shows\"…\"with visible backslashes. Either remove the backslashes ("[Internal] Category: ...") or wrap the format spec in backticks for inline-code rendering. -
Wrap the regex in backticks so GitHub Markdown doesn't try to interpret characters like
|,?,.,[,]:Regex: `(\[Internal\]|\[v4\] )?.{3}.+: (Adds|Fixes|Refactors|Removes) .{3}.+`
Nit: the new blank line between the regex and the [Internal] paragraph has 9 trailing spaces — harmless in YAML, but some lint configs flag it.
Otherwise LGTM 👍
Updated regex comment formatting in PR linting workflow.
kushagraThapar
left a comment
There was a problem hiding this comment.
LGTM, thanks @yash2710 !
Description
Updated the comment format for regex failure messages and examples in the PR lint workflow.
Type of change
Please delete options that are not relevant.
Closing issues
Changelog
### Unreleasedinchangelog.mdfor the user-facing impact of this change.
documentation-only, test-only, CI / build-only, or a pure internal refactor
with no observable customer impact.
If the second box is checked, briefly justify here: