Skip to content

Conversation

@jdx
Copy link
Owner

@jdx jdx commented Jan 19, 2026

Summary

Wrap Vec<String> and Vec<char> in backticks to prevent them from being interpreted as unclosed HTML tags in rustdoc.

Fixes doc comments for:

  • defaults! macro
  • shorts! macro
  • longs! macro
  • aliases! macro

🤖 Generated with Claude Code


Note

Minor rustdoc formatting fix.

  • Escapes Vec<String> and Vec<char> in doc comments for defaults!, shorts!, longs!, and aliases! macros to avoid HTML tag interpretation
  • No functional or API changes

Written by Cursor Bugbot for commit 5b009b5. This will update automatically on new commits. Configure here.

Wrap `Vec<String>` and `Vec<char>` in backticks to prevent them from
being interpreted as unclosed HTML tags in rustdoc.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 19, 2026 19:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes rustdoc rendering issues by wrapping generic type parameters in backticks to prevent them from being misinterpreted as HTML tags.

Changes:

  • Escaped Vec<String> and Vec<char> type parameters in macro documentation comments

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Jan 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.66%. Comparing base (949e3a5) to head (5b009b5).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #453   +/-   ##
=======================================
  Coverage   47.66%   47.66%           
=======================================
  Files          47       47           
  Lines        6928     6928           
  Branches     6928     6928           
=======================================
  Hits         3302     3302           
  Misses       1780     1780           
  Partials     1846     1846           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jdx jdx merged commit 27e29c2 into main Jan 19, 2026
11 checks passed
@jdx jdx deleted the feat/fix-doc-comments branch January 19, 2026 19:43
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