diff options
author | Jon Dufresne <jon.dufresne@gmail.com> | 2020-12-17 12:09:23 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-17 15:09:23 -0500 |
commit | a1907c037a44e3dda54ea60163a15e11cfd81774 (patch) | |
tree | 916cf4c217a2c11c2d7afcf721c45c2637235dfd /.github | |
parent | e3a1ba52b5926bd419a5bab73c64d7bce1089958 (diff) | |
download | pyjwt-a1907c037a44e3dda54ea60163a15e11cfd81774.tar.gz |
Update code blocks in docs (#545)
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.
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE.md | 1 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/Bug.md | 1 |
2 files changed, 0 insertions, 2 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 7a5ed7b..0726207 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -12,7 +12,6 @@ What happened instead. ```python import jwt - ``` ## System Information diff --git a/.github/ISSUE_TEMPLATE/Bug.md b/.github/ISSUE_TEMPLATE/Bug.md index 390795f..5b8168e 100644 --- a/.github/ISSUE_TEMPLATE/Bug.md +++ b/.github/ISSUE_TEMPLATE/Bug.md @@ -17,7 +17,6 @@ What happened instead. ```python import jwt - ``` ## System Information |