Skip to content

docs(parsers): clear rustdoc invalid_html_tags warnings on doc comments#8775

Merged
keivenchang merged 1 commit into
mainfrom
keivenchang/parsers-minor-comment-only-update
Apr 28, 2026
Merged

docs(parsers): clear rustdoc invalid_html_tags warnings on doc comments#8775
keivenchang merged 1 commit into
mainfrom
keivenchang/parsers-minor-comment-only-update

Conversation

@keivenchang
Copy link
Copy Markdown
Contributor

@keivenchang keivenchang commented Apr 27, 2026

Overview:

Non-functional cleanup — wrap inline XML/markup markers in backticks and angle-bracket bare URLs in doc comments so rustdoc stops emitting invalid_html_tags warnings.

Details:

  • lib/parsers/src/reasoning/minimax_append_think_parser.rs — angle-bracket the two SGLang/vLLM reference URLs
  • lib/parsers/src/tool_calling/config.rs — backtick <TOOLCALL>, <function=, <parameter=, </tool_call>, </function>, </parameter> markers in JsonParserConfig and XmlParserConfig doc comments
  • lib/parsers/src/tool_calling/xml/parser.rs — backtick <tool_call>...</tool_call> format markers on detect_tool_call_start_xml, try_tool_call_parse_xml, parse_tool_call_block doc comments
  • lib/parsers/src/tool_calling/dsml/parser.rs — replace internal Linear ref DIS-1765 with the public PR reference (fix(parsers): recover Kimi K2 tool calls when section_end is missing #8208)

Where should the reviewer start?

lib/parsers/src/tool_calling/config.rs

/coderabbit profile chill

Wraps inline XML/markup markers in backticks so rustdoc treats them as
literal code rather than parsing them as HTML, and angle-brackets bare
URLs so rustdoc renders them as links.

- minimax_append_think_parser.rs: angle-bracket the two SGLang/vLLM
  reference URLs
- tool_calling/config.rs: backtick the <TOOLCALL>, <function=>,
  <parameter=>, </tool_call>, </function>, </parameter> markers in
  doc comments on JsonParserConfig and XmlParserConfig fields
- tool_calling/xml/parser.rs: backtick the <tool_call>...</tool_call>
  format markers on detect_tool_call_start_xml,
  try_tool_call_parse_xml, parse_tool_call_block doc comments
- tool_calling/dsml/parser.rs: replace internal Linear ref DIS-1765
  with the public PR reference (#8208) that fixed the kimi_k2 missing
  end-token recovery class

No code change; cargo doc and cargo build both pass.

Signed-off-by: Keiven Chang <keivenchang@users.noreply.github.com>
@keivenchang keivenchang requested a review from a team as a code owner April 27, 2026 23:11
@keivenchang keivenchang self-assigned this Apr 27, 2026
@github-actions github-actions Bot added the docs label Apr 27, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 27, 2026

Walkthrough

This pull request consists entirely of documentation and comment updates across multiple parser files. Changes include reformatting example strings with inline code backticks, updating GitHub URL references to HTML-style links, and adjusting test comment references without any modifications to parsing logic or behavior.

Changes

Cohort / File(s) Summary
Tool Calling Documentation Format Updates
lib/parsers/src/tool_calling/config.rs, lib/parsers/src/tool_calling/xml/parser.rs
Updated Rust doc comments to wrap example XML/marker strings and format examples in inline code using backticks for improved readability.
Reference Updates
lib/parsers/src/reasoning/minimax_append_think_parser.rs, lib/parsers/src/tool_calling/dsml/parser.rs
Reformatted GitHub URLs to HTML-style links (angle brackets) and updated test TODO reference from "DIS-1765" to "PR #8208" without changing documented behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: fixing rustdoc warnings by formatting documentation comments in parser files.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description includes all required sections (Overview, Details, Where should the reviewer start) with clear, specific information about the changes being made.

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


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.

@keivenchang keivenchang merged commit 02f4af7 into main Apr 28, 2026
94 checks passed
@keivenchang keivenchang deleted the keivenchang/parsers-minor-comment-only-update branch April 28, 2026 00:14
furionw pushed a commit that referenced this pull request May 2, 2026
…ts (#8775)

Signed-off-by: Keiven Chang <keivenchang@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants