Adapt Examples sections to be multiline for mkdocs #34
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
ghost
requested review from
ghost
self-assigned this
pawtom
approved these changes
Jun 21, 2023
Adakar
reviewed
Jun 26, 2023
There was a problem hiding this comment.
For two or more independent examples using >>> seems to be ok but for for code blocks like sections I'd prefer to see Python code blocks - that seems to be supported by mkdocs as well
Changes: - Rename Example to Examples for all Example sections. This is required for mkdocs to display multi-line examples correctly. - Add the >>> to each line in the Examples. It forces mkdocs to not squash examples into one line.
Adakar
force-pushed
the
adapt-docstrings-for-mkdocs
branch
from
e4a50c1 to
032fa9e
Compare
pawtom
approved these changes
Jul 5, 2023
Adakar
approved these changes
Jul 10, 2023
Adakar
added a commit
that referenced
this pull request
Aug 22, 2023
* Adapt Examples sections to be multiline for mkdocs Changes: - Rename Example to Examples for all Example sections. This is required for mkdocs to display multi-line examples correctly. - Add the >>> to each line in the Examples. It forces mkdocs to not squash examples into one line. * Fix imports in squishserver module * Fix docstrings: multiline examples and Args --------- Co-authored-by: Adakar <jakub.top@gmail.com>
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.
Changes: