Test Python docstring in markdown files #38
Merged
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
And experiment with tested snippets
sgillies
commented
May 3, 2023
docs/expressions.md
Outdated
| ## Snippet test | ||
|
|
||
| ```python | ||
| --8<-- "tests/test_cli.py:map" |
There was a problem hiding this comment.
@kevinlacaille here's my first snippet test!
sgillies
commented
May 3, 2023
| @@ -68,6 +68,9 @@ nav: | |||
| - "Topics": 'topics' | |||
|
|
|||
| markdown_extensions: | |||
| - pymdownx.inlinehilite | |||
| - pymdownx.snippets: | |||
| dedent_subsections: True | |||
There was a problem hiding this comment.
Extension configuration here
There was a problem hiding this comment.
Oh, maybe this is what I'm missing! I'll have to give this a shot.
sgillies
commented
May 3, 2023
tests/test_cli.py
Outdated
| ) | ||
| # --8<-- [end:map] |
|
@kevinlacaille looks good to me!
|
sgillies
commented
May 3, 2023
| --8<-- [end:reduce] | ||
| """.splitlines()[ | ||
| 2 | ||
| ].strip() |
There was a problem hiding this comment.
@kevinlacaille I've got some tested CLI snippets! It's a little tortured, I'm working against Python to keep quotes out of the snippet section, but it works!
|
This is really helpful, I'm absolutely going to refer to this in planetlabs/planet-client-python#941 - thanks! |
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.
And experiment with tested snippets