-
Notifications
You must be signed in to change notification settings - Fork 38
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
Move tokenstorage #1065
Move tokenstorage #1065
Conversation
Internal Tracking |
@@ -0,0 +1,20 @@ | |||
|
|||
Token Caching |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe controversially I titled this section "token caching" rather than "token storage". This is to disambiguate with the subpages that provide references for specific versions of the same concept.
Alternative Structure
docs/
- authorization/
- token_storage/
- token_storages.rst
- index.rst
- storage_adapters.rst
and you'd end up with pages titled "Token Storage", "Token Storages", and "Storage Adapters (Legacy)".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I acknowledge that there is quite a bit of docstring pedantry here.
Nevertheless, I think that it will increase internal consistency, and make the documentation more readable.
To help with reviewing, each of the below steps have been done in separate commits.
What?
TokenStorage
and its subclasses fromglobus_sdk.experimental.tokenstorage
toglobus_sdk.tokenstorage
(with respect to terms of where it's exposed).docs/tokenstorage.rst
doc todocs/authorization/token_caching/storage_adapters.rst
, leaving behind an orphaned page redirecting users with existing links.docs/authorization/token_caching/token_storage.rst
page.📚 Documentation preview 📚: https://globus-sdk-python--1065.org.readthedocs.build/en/1065/