Update code blocks in docs #545
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
|
@jdufresne you've outdone yourself. I'm very thankful for all this awesome work you've done. ❤️
It'd be interesting to set this up in CI / pre-commit. |
jpadilla
approved these changes
Dec 17, 2020
Good idea. I've included this in the latest revision. |
Update Python 2 syntax and drop Python-2-only examples. Fix all Python console prompts to the full ">>> " for correct highlighting. Use "pycon" instead of "python" for interactive Python console session. The "python" lexer is for Python scripts and doesn't interpret the ">>>" prompt. Fix all Python console code blocks to more accurately display what the user will see. For example, when assigning a value to a variable, it isn't also echoed. Fix typo ".. code::" → ".. code-block::". Use "console" instead of "sh" for shell sessions. The "sh" lexer is for shell scripts. For a complete list of lexers, see: https://pygments.org/docs/lexers/ Use blacken-docs to run black on code blocks. This is now included as a pre-commit hook.
auvipy
requested changes
Dec 17, 2020
auvipy
approved these changes
Dec 17, 2020
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.
Update Python 2 syntax and drop Python-2-only examples.
Fix all Python console prompts to the full ">>> " for correct
highlighting.
Use "pycon" instead of "python" for interactive Python console session.
The "python" lexer is for Python scripts and doesn't interpret the ">>>"
prompt.
Fix all Python console code blocks to more accurately display what the
user will see. For example, when assigning a value to a variable, it
isn't also echoed.
Fix typo ".. code::" → ".. code-block::".
Use "console" instead of "sh" for shell sessions. The "sh" lexer is for
shell scripts. For a complete list of lexers, see:
https://pygments.org/docs/lexers/
Use blacken-docs to run black on code blocks.