-
-
Notifications
You must be signed in to change notification settings - Fork 369
chore: fix broken links #1765
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
chore: fix broken links #1765
Conversation
WalkthroughThis PR updates two documentation links from HTTP to HTTPS. A Doxygen URL in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@doc/developer-notes.md`:
- Around line 107-108: Replace the bare URL in the sentence "A full list of
comment syntaxes picked up by doxygen can be found at
https://www.doxygen.nl/manual/docblocks.html" with a markdown link (e.g., "A
full list of comment syntaxes picked up by doxygen can be found at [Doxygen
docblocks](https://www.doxygen.nl/manual/docblocks.html)") so the file no longer
violates MD034; update the doc string accordingly wherever that bare URL
appears.
| A full list of comment syntaxes picked up by doxygen can be found at https://www.doxygen.nl/manual/docblocks.html | ||
| but if possible use one of the above styles. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wrap the bare URL to satisfy MD034.
This line violates no-bare-urls; convert to a markdown link.
✅ Proposed fix
-A full list of comment syntaxes picked up by doxygen can be found at https://www.doxygen.nl/manual/docblocks.html
+A full list of comment syntaxes picked up by doxygen can be found at
+[the Doxygen docblocks reference](https://www.doxygen.nl/manual/docblocks.html).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A full list of comment syntaxes picked up by doxygen can be found at https://www.doxygen.nl/manual/docblocks.html | |
| but if possible use one of the above styles. | |
| A full list of comment syntaxes picked up by doxygen can be found at | |
| [the Doxygen docblocks reference](https://www.doxygen.nl/manual/docblocks.html). | |
| but if possible use one of the above styles. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
107-107: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In `@doc/developer-notes.md` around lines 107 - 108, Replace the bare URL in the
sentence "A full list of comment syntaxes picked up by doxygen can be found at
https://www.doxygen.nl/manual/docblocks.html" with a markdown link (e.g., "A
full list of comment syntaxes picked up by doxygen can be found at [Doxygen
docblocks](https://www.doxygen.nl/manual/docblocks.html)") so the file no longer
violates MD034; update the doc string accordingly wherever that bare URL
appears.
|
bugbot run |
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html - broken
https://www.doxygen.nl/manual/docblocks.html - correct
http://en.cppreference.com/w/cpp/concept/Iterator - broken
https://en.cppreference.com/w/cpp/iterator.html - correct