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

Convert documentation of PKCE functions to our style #26

Open
ftsell opened this issue Sep 30, 2024 · 0 comments
Open

Convert documentation of PKCE functions to our style #26

ftsell opened this issue Sep 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ftsell
Copy link
Member

ftsell commented Sep 30, 2024

Currently, the documentation of pkce.py is not using the same docstring style as the rest of the codebase.
This should be changed to be more consistent.

pkce.py uses this style:

Parameters
----------
length : int
    Code verifier length. Must verify `43 <= length <= 128`.

whereas other code (e.g. discovery.py) uses this:

:param issuer: The base url of the provider. This url will be appended with `/.well-known/openid-configuration` to retrieve the provider configuration so that must be a valid URL for your provider.
:returns: The well-formed and validated configuration of the given issuer
:raises OpenidProtocolError: When the communication with the provider was not possible or the response was not in an expected format
@ftsell ftsell added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant