📝 State full YAML test suite compliance and document compact block keys#87
Conversation
With the suite-conformance work landed, yamlrocks passes the complete official YAML 1.2 test suite, so the landing page says so plainly instead of "exercised against". Add a complex-key example for a compact block collection written after a ? key indicator (spec example 8.19), the form the parser now handles.
|
Warning Review limit reached
More reviews will be available in 36 minutes and 24 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
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 |
There was a problem hiding this comment.
Pull request overview
This documentation-only PR updates the marketing/correctness wording now that YAMLRocks passes the complete official YAML 1.2 test suite, and documents a newly supported syntax. On the landing page, the "Correct" card and project-status note change "exercised/verified against" the test suite to "passes the complete official YAML test suite." The complex-keys guide gains an example showing a compact block collection used after a ? key indicator (spec example 8.19). Both changes depend on PR #86 (compact block collections as keys), which the description notes must merge first.
I verified that in this checkout parse_failures contains only V9D5 (the case #86 fixes) while the large rejected list is invalid documents the parser correctly refuses, so the compliance wording becomes accurate once #86 lands. The new example's asserted output ({(("earth", "blue"),): {"moon": "white"}}) matches #86's documented behavior, and the spec link/anchor format is consistent with the existing example link in the same file.
Changes:
- Reword the landing page's "Correct" card and project-status note to state full YAML test-suite compliance.
- Add a compact-block-collection-as-key example (spec 8.19) to the complex-keys guide.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/src/content/docs/index.mdx |
Updates the "Correct" card and status note to claim passing the complete official YAML test suite. |
docs/src/content/docs/guides/loading.md |
Adds a compact block collection key example; the block omits the import yamlrocks that every other example block includes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Breaking change
None. Documentation only.
Proposed change
With the suite-conformance work landed, yamlrocks passes the complete official YAML 1.2 test suite, so the docs say so plainly. The landing page's "Correct" card and project-status note change "exercised against" / "verified against" the test suite to "passes the complete official YAML test suite". The complex-keys guide gains an example for a compact block collection written after a
?key indicator (spec example 8.19), the form the parser now handles, alongside the existing flow-style examples.The existing complex-keys and
OPT_REJECT_COMPLEX_KEYSdocumentation already described the behavior generically and is unchanged.Note on ordering: the new example and the full-compliance wording rely on #86 (compact block collections as keys). This should merge after #86 so the documented example verifier stays green.
This is related to #77 and #86.
Type of change
Additional information
Checklist
uv run pytestpasses locally. A pull request cannot be merged unless CI is green.uv run ruff check .anduv run ruff format --check .pass.cargo fmt --checkandcargo clippy --all-targets -- -D warningspass.If the change is user-facing:
docs/is added or updated, anddocs/verify_examples.pystill passes.