docs(fulfillment): align rendering contract with totals schema#573
Open
juanferrub wants to merge 3 commits into
Open
docs(fulfillment): align rendering contract with totals schema#573juanferrub wants to merge 3 commits into
juanferrub wants to merge 3 commits into
Conversation
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.
Summary
This updates the fulfillment rendering prose to match the existing schema and examples.
Specifically, it:
totaltototalsnulltotalPlease let me know if I'm missing something, but it looks like the schema and examples consistently use
totals, so this PR treats that as the source of truth and aligns the prose with it.Why
Issue #559 points out that
docs/specification/fulfillment.mddocumentsgroups[].options[].totalas a required nullable scalar, while the actual schema requiresgroups[].options[].totalsas an array of non-null amount entries.The schema and examples already agree with each other, so this PR keeps the change intentionally narrow and only fixes the prose.
Validation
I triple-checked this in the local repo with the project tooling:
scripts/test_validate_examples.py->43 passed, 0 failedscripts/validate_examples.py --schema-base source/schemas/->270 passed, 0 failed, 0 errors, 45 skippedscripts/check_links.py site-> passed, all internal links validgit diff --check-> passedBuild note
I also checked the stricter docs build path locally. The full strict MkDocs build still aborts on pre-existing local-environment warnings, especially repeated
cairosvg/ missinglibcairowarnings on this Mac. I verified those warnings reproduce on cleanmainas well, so they do not appear to be introduced by this change.