WIP: Docs fix broken list code example #5719
Draft
Conversation
This file contains 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
MeelahMe
changed the title
jstirnaman
requested changes
Dec 20, 2024
Comment on lines
-18
to
-23
| <!-- Import for tests and hide from users. | ||
| ```python | ||
| import os | ||
| ``` | ||
| --> | ||
| <!--pytest-codeblocks:cont--> |
There was a problem hiding this comment.
If you just remove the comments and commented lines, it should fix the list page display--that's the quick fix.
As a more strategic fix, I like your idea, but...
- it would also require changing the section (
_index) page template to support it. - the page that includes the example would need to hide it from displaying
I'm fine with a quick fix. For the "strategic" fix, my preference would probably be to change the parsing/rendering of the existing list_code_example frontmatter field to support the test setup comments.
There was a problem hiding this comment.
...just thinking out loud... a better "fix" might be to have the test runner inject
import osfor each example before running it - that eliminates the need for alot of pytest comments in the pages.
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.
Closes #
Describe your proposed changes here.
(if necessary)