[https://nvbugs/6633929][fix] Fix XGrammar structural tag doc links and pin the source link - #18430
Conversation
|
/bot run --disable-fail-fast |
…nd pin the source link Repoint the three structural-tag tutorial links from the removed docs/structural_tag/structural_tag_api.html (404) to the live docs/latest/structural_tag/structural_tag.html and drop the stale test_doc.py::test_url_validity waiver. Also pin the backend source link to the shipped version (v0.1.21 -> v0.1.32, matching requirements.txt) and retarget it to compiler.py#L144-L290, the GrammarCompiler methods for JSON schema, regex, structural tag and EBNF; the old matcher.py#L341-L350 anchor no longer marked anything relevant. The tutorial links stay on /docs/latest/ because XGrammar publishes no versioned doc paths. Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
2f551de to
1685bbe
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
💤 Files with no reviewable changes (1)
Included review availability: Your plan provides up to 12 included reviews per hour; 8 remain after this review. WalkthroughThe pull request updates XGrammar links in the guided-decoding documentation and removes the URL validation test waiver. ChangesGuided decoding documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to The change updates broken documentation links and aligns the source reference with the shipped XGrammar version; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description clearly explains the documentation and source-link changes and includes verification results. It does not use the exact Test Coverage or PR Checklist sections, but the provided verification is sufficient for this documentation-only change. Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/bot run --disable-fail-fast |
|
PR_Github #70271 [ run ] triggered by Bot. Commit: |
|
PR_Github #70272 [ run ] triggered by Bot. Commit: |
|
PR_Github #70271 [ run ] completed with state |
|
PR_Github #70272 [ run ] completed with state |
Description
Supersedes #18016 (its two commits are included), addressing the review feedback on top:
https://xgrammar.mlc.ai/docs/structural_tag/structural_tag_api.html(404) to the livehttps://xgrammar.mlc.ai/docs/latest/structural_tag/structural_tag.html, and remove the now-unneededtest_doc.py::test_url_validitywaiver. (from [https://nvbugs/6633929][fix] Repoint all three links to the live versioned page and remove the now-unneeded… #18016)v0.1.21->v0.1.32, matchingxgrammar==0.1.32inrequirements.txt. The old anchormatcher.py#L341-L350no longer marked anything relevant even at v0.1.21; the link now targetscompiler.py#L144-L290, theGrammarCompilermethods for JSON schema, regex, structural tag and EBNF./docs/latest/because XGrammar publishes no versioned doc paths (/docs/v0.1.32/and/docs/0.1.32/both 404; verified).Verification
All three URL forms verified with curl: new tutorial link and the v0.1.32
compiler.pylink return 200; the versioned doc-path variants 404.🤖 Generated with Claude Code
Dev Engineer Review
/docs/latest/structural_tag/structural_tag.htmlpath.xgrammar==0.1.32andcompiler.py#L144-L290.test_doc.py::test_url_validitywaiver.QA Engineer Review
test_doc.py::test_url_validityfromtests/integration/test_lists/waives.txt.test-db/orqa/files were modified.