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

Refs #26029 -- Minimally documented StorageHandler API. #18277

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

carltongibson
Copy link
Member

Trac ticket number

ticket-26029

Branch description

Third-party packages that provide storages need to rely on the StorageHandler API in order to allow users to use the storages API to override defaults. Minimally documenting these methods allows package authors to rely on them.

See forum discussion https://forum.djangoproject.com/t/document-storagehandler-as-public-api/32101

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

Third-party packages that provide storages need to rely on the
StorageHandler API in order to allow users to use the `storages` API
to override defaults. Minimally documenting these methods allows
package authors to rely on them.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant