docs(parsers): clear rustdoc invalid_html_tags warnings on doc comments#8775
Merged
Merged
Conversation
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>
Contributor
WalkthroughThis 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ 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. Comment |
ayushag-nv
approved these changes
Apr 28, 2026
furionw
pushed a commit
that referenced
this pull request
May 2, 2026
…ts (#8775) Signed-off-by: Keiven Chang <keivenchang@users.noreply.github.com>
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.
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_tagswarnings.Details:
lib/parsers/src/reasoning/minimax_append_think_parser.rs— angle-bracket the two SGLang/vLLM reference URLslib/parsers/src/tool_calling/config.rs— backtick<TOOLCALL>,<function=,<parameter=,</tool_call>,</function>,</parameter>markers inJsonParserConfigandXmlParserConfigdoc commentslib/parsers/src/tool_calling/xml/parser.rs— backtick<tool_call>...</tool_call>format markers ondetect_tool_call_start_xml,try_tool_call_parse_xml,parse_tool_call_blockdoc commentslib/parsers/src/tool_calling/dsml/parser.rs— replace internal Linear refDIS-1765with 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