Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation: complete encode and decode docs #459

Closed
dimaqq opened this issue Nov 7, 2019 · 1 comment · Fixed by #482
Closed

Better documentation: complete encode and decode docs #459

dimaqq opened this issue Nov 7, 2019 · 1 comment · Fixed by #482

Comments

@dimaqq
Copy link
Contributor

dimaqq commented Nov 7, 2019

https://pyjwt.readthedocs.io/en/latest/index.html has examples 😄
https://pyjwt.readthedocs.io/en/latest/api.html has only exceptions 😕

I wish there was complete documentation for jwt.encode and jwt.decode high level methods / public API.

Specifically, there are keyword arguments which are not trivial and options= which have defaults, but it takes digging into the source code to understand how the earlier work and what the latter are.

@tobni
Copy link

tobni commented Apr 23, 2020

Agreed, was bit by the lack of docs and received deprecation warnings for

jwt.decode(msg, verify=False)

Had to consult source to find the use of the favored

jwt.decode(msg, options={'verify_signature': False})

jpadilla added a commit that referenced this issue Apr 26, 2020
Co-authored-by: José Padilla <jpadilla@webapplicate.com>
jpadilla added a commit that referenced this issue Jun 19, 2020
Co-authored-by: José Padilla <jpadilla@webapplicate.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants