Document how to indent YAML block sequences - #134
Open
user01010111 wants to merge 1 commit into
Open
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.
Addresses #115 with a tested recipe using the existing
Dumperkeyword. It explains whyindent=4alone leaves sequences indentless and why the override must subclass Python'syaml.SafeDumper, including when LibYAML is installed.The example checks exact indentation and round-trips nested metadata and content. It retains safe serialisation and explains that source formatting is not preserved. No dependencies, formatting defaults or handler APIs change.
Validation: 68 tests passed on Python 3.13 with PyYAML 6.0.3 and LibYAML; mypy and package build passed. The HTML docs build succeeds with the same 12 warnings as the base revision. All eight recipe doctests pass; the full Sphinx doctest run still has the existing API setup failure caused by
>>> import frontmatterinside atestsetupblock.