Skip to content

Conversation

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 26, 2026

Walkthrough

This PR updates two documentation links from HTTP to HTTPS. A Doxygen URL in doc/developer-notes.md is corrected to the updated domain, and a cppreference link in a comment within src/immer/detail/type_traits.hpp is updated to use HTTPS with a corrected path.

Changes

Cohort / File(s) Change Summary
Documentation URL Updates
doc/developer-notes.md, src/immer/detail/type_traits.hpp
Updated two broken reference URLs: Doxygen URL in developer notes from http://www.stack.nl/~dimitri/doxygen/... to https://www.doxygen.nl/..., and cppreference iterator concept URL in type traits comment from http://en.cppreference.com/... to https://en.cppreference.com/...

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 Two links were broken, now they're fixed with care,
From http to https, a modernizing flair,
Through doxygen and cppreference we hop,
Documentation bouncing without a stop!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description lists the broken and corrected links but does not follow the required template with 'PR intention' and 'Code changes brief' sections. Restructure the description to include the mandatory 'PR intention' section explaining what the PR does, following the repository's required template format.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: fix broken links' directly and clearly summarizes the main change—updating broken documentation links to their correct URLs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

Comment on lines +107 to 108
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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.

@reubenyap
Copy link
Member

bugbot run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants