Clarify APIView.dispatch request lifecycle in docstring #9884
+20
−4
Conversation
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
thawancomt
reviewed
Feb 5, 2026
| > — [Reinout van Rees][cite] | ||
|
|
||
| REST framework provides an `APIView` class, which subclasses Django's `View` class. | ||
| REST framework provides an `APIView` class, which subclasses Django’s base `View` class. |
thawancomt
reviewed
Feb 5, 2026
| """ | ||
| `.dispatch()` is pretty much the same as Django's regular dispatch, | ||
| but with extra hooks for startup, finalize, and exception handling. | ||
| Dispatch the incoming request to the appropriate handler method. |
There was a problem hiding this comment.
It's good, mentioning the flow is actually a good point
Member
There was a problem hiding this comment.
Yeah, that's definitely an improvement
browniebroke
reviewed
Feb 6, 2026
Member
There was a problem hiding this comment.
Changes in this file were rejected in #9882 please don't submit them again
| """ | ||
| `.dispatch()` is pretty much the same as Django's regular dispatch, | ||
| but with extra hooks for startup, finalize, and exception handling. | ||
| Dispatch the incoming request to the appropriate handler method. |
Member
There was a problem hiding this comment.
Yeah, that's definitely an improvement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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 improves the docstring for
APIView.dispatchto better documentthe request/response lifecycle in Django REST Framework.
The updated docstring explains:
No functional changes are introduced.