docs: fix demo.md snippet includes broken by ruff 0.16 - #78
Merged
Conversation
ruff 0.16 formats Python code blocks embedded in Markdown. It parsed the pymdownx.snippets include directives in demo.md (--8<-- "examples/*.py") as Python expressions and rewrote them to `--8 < --'examples/*.py'`, which neither the docs site nor scripts/build_llms_full.py can resolve — so the demo page and llms-full.txt lost their inlined example sources. - Restore the three directives to the canonical `--8<-- "..."` form. - Exclude docs/demo.md from ruff (extend-exclude) so the formatter stops mangling the non-Python include directives; the file has no real Python to format, only these includes. - Regenerate docs/llms-full.txt: the examples inline again and the page syncs with the current sources.
Coverage report
This PR does not seem to contain any modification to coverable code. |
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.
Summary
ruff 0.16 formats Python code blocks embedded in Markdown. It parsed the pymdownx.snippets include directives in demo.md (--8<-- "examples/*.py") as Python expressions and rewrote them to
--8 < --'examples/*.py', which neither the docs site nor scripts/build_llms_full.py can resolve — so the demo page and llms-full.txt lost their inlined example sources.--8<-- "..."form.