summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJon Dufresne <jon.dufresne@gmail.com>2020-12-21 08:13:07 -0800
committerGitHub <noreply@github.com>2020-12-21 11:13:07 -0500
commitd5eff6452d66d0cafce9fecd19f5453ce8ea95fc (patch)
tree91c149a4d9e6dea428f6e49c7848effa05b02a6d /README.rst
parent92aeab415ae2b73d2776ad2b1c4e8fa3a5e0d51e (diff)
downloadpyjwt-d5eff6452d66d0cafce9fecd19f5453ce8ea95fc.tar.gz
Fix tox "docs" environment to pass (#567)
- Fixed doctest which included incorrect output. - Use intersphinx to allow linking to Python JSONEncoder class. - Fix param types after previous str/bytes cleanups. - Fix param syntax to avoid vertical bar. The command `tox -e docs` now passes.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 432631e..49aa77a 100644
--- a/README.rst
+++ b/README.rst
@@ -42,7 +42,7 @@ Usage
>>> import jwt
>>> encoded = jwt.encode({"some": "payload"}, "secret", algorithm="HS256")
>>> print(encoded)
- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzb21lIjoicGF5bG9hZCJ9.4twFt5NiznN84AWoo1d7KO1T_yoc0Z6XOpOVswacPZg
+ eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzb21lIjoicGF5bG9hZCJ9.Joh1R2dYzkRvDkqv3sygm5YyK8Gi4ShZqbhK2gxcs2U
>>> jwt.decode(encoded, "secret", algorithms=["HS256"])
{'some': 'payload'}