Repository navigation
docs: enhance sponsorship uc documentation - #1928
Merged
Merged
Conversation
JacobCoffee
reviewed
Sep 12, 2024
JacobCoffee
changed the title
|
Does this PR still need a change? |
Port of #1928 onto current main. BaseUseCaseWithNotifications becomes an ABC with an abstract execute(), the use case docstrings gain the extra context from the original PR, and the admin docs describe how the sponsors app is operated. The django-extensions dependency and the generated schema image are dropped. Co-authored-by: Bernardo Fontes <bernardoxhc@gmail.com>
JacobCoffee
force-pushed
the
topic/sponsorship-uc-documentation
branch
from
October 8, 2026 03:30
1caac5a to
d5f8017
Compare
JacobCoffee
enabled auto-merge
October 8, 2026 03:40
JacobCoffee
approved these changes
Oct 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR tries to document better the sponsor app to make it easier for other developers to onboard it.
It mostly updates the use cases with docstrings explaining their logic. It also adds an image file with the database schema to the readthedocs page.
To generate the DB schema, I used django-extensions graph model command line interface.