Fix three doc-reference lint hits blocking every PR - #1861
Closed
sbryngelson wants to merge 1 commit into
Closed
Conversation
Member
Author
|
Superseded by #1857, which covers these three plus the rest of the doc-lint cleanup. |
Contributor
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Pull request overview
This PR fixes three documentation-reference lint failures that were causing Doxygen/doc lint checks to fail for every PR.
Changes:
- Add the missing Doxygen anchor
{#selection-and-execution-pitfalls}to match an existing link target. - Wrap two inline-code spans containing single quotes in double backticks to prevent Doxygen from prematurely terminating the code span.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/documentation/testing.md | Adds the missing header anchor so existing intra-doc links resolve. |
| docs/documentation/gpuParallelization.md | Uses double-backtick inline code for a macro example containing single quotes. |
| docs/documentation/contributing.md | Uses double-backtick inline code for a $:GPU_UPDATE(...) example containing single quotes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Master's Lint Toolchain has been red since #1855 (5953684), and because PR checks run against the merge with base, it fails every open PR rather than just master. #1847, #1843 and #1839 are all red on it right now.
Three lines: double backticks around the two spans that contain a quote, and the anchor added to the
### Selection and Execution Pitfallsheader the link already points at.python3 toolchain/mfc/lint_docs.pyand./mfc.sh precheckboth pass on this branch.Split out of #1859 so it can go in on its own - that PR carries an unrelated
m_viscous.fppfix and will sit in review, and this is blocking everyone's CI meanwhile.