Keep doctest examples whole and inside their block - #336
Open
has2k1 wants to merge 1 commit into
Open
Conversation
Unfenced doctest prompts were wrapped in Python fences whose markers began at column 0, while expected output remained outside each fence. A nested example therefore escaped its list item or indented section. Output such as `<Widget>` then reached Quarto as raw Markdown. Quarto treated it as HTML and omitted it from the page. Align each fence with its prompts and include expected output until the blank line or dedent that ends the example. This matches the span recognised by `doctest` and keeps prompts with their results.
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
1 participant
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.
This PR fixes doctest examples that were coming out mangled. When the prompts sat inside a list item or a Google-style section, the fence around them opened back at the left margin and tore the example out of whatever held it, and the expected output never made it inside the fence at all, so a line like
<Widget>went to Pandoc as raw HTML and simply vanished from the page.