Declare the version the page is about in the custom example - #34
Merged
Alex-GF merged 1 commit intoJul 31, 2026
Merged
Conversation
The example under 'custom' is shared by the 3.0 and 3.1 specification pages and hard-codes syntaxVersion: "3.1", so a reader following the 3.0 page is shown a snippet declaring a different version of the language than the one they are reading about. Split per version, the way syntaxVersion itself already is.
|
@javiercavlop is attempting to deploy a commit to the alexgf's projects Team on Vercel. A member of the Team first needs to authorize it. |
Alex-GF
approved these changes
Jul 31, 2026
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.
Context
While integrating an asyncio gateway against SPACE I read the Pricing2Yaml 3.1 page and wrote
syntaxVersion: "3.0"into our pricing, because that is what the page said. I flagged it on isa-group/space#58, and it is already fixed here by 107c545 — the v3.1 page now has its own_syntax_version_31.mdxinstead of importing the 3.0 partial. Thank you.This PR is the same class of error, one field further down, and it is still present on
develop.The problem
versions/v3.0/_custom.mdxis imported by both specification pages:and its example hard-codes one version:
So a reader on the Version 3.0 page, at
## custom, is shown a snippet declaringsyntaxVersion: "3.1".customis a documented field of 3.0 — the v3.0 page has its own## customsection — so the field belongs on both pages; only the version number in the example is wrong for one of them.This is the failure mode the
syntaxVersionfix just addressed: a partial that is correct for the version it lives under, reused by a page about a different version. It is easy to trust, because the surrounding page is about 3.0 and nothing signals that one line of the example is not.The change
Split the partial per version, the way
syntaxVersionalready is:v3.0/_custom.mdx— example now declaressyntaxVersion: "3.0".v3.1/_custom.mdx— new, identical but declaring"3.1".pricing2yaml-v31-specification.mdximports the 3.1 partial.Nothing else changes: same prose, same warning admonition, same
VersionTable.Verification
pnpm buildsucceeds, and the rendered HTML of each page carries the right number under## custom:I also swept the rest of the Pricing2Yaml version partials for the same pattern — an example hard-coding a
syntaxVersioninside a partial shared across version pages — and_custom.mdxis the only remaining one. The other partials the 3.1 page imports fromv3.0/(_usage_limits_type,_usageLimits_period,_usageLimits_trackable,_addons_subscriptionConstraints) carry no version-specific value, so sharing them is correct.Scope
Three files, one of them a copy. No prose rewritten and no change to what either version of the language actually specifies.