-
-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Improve docstring for get_serializer to clarify behavior
#9870
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
Merged
browniebroke
merged 6 commits into
encode:main
from
MoeSalah1999:add-docstrings-serializer-fields
Feb 21, 2026
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
795e149
docs: improve docstring for get_serializer to clarify behavior
MoeSalah1999 f4b6dd0
Tweak formatting
browniebroke 8f0bd56
Merge branch 'encode:main' into add-docstrings-serializer-fields
MoeSalah1999 765b090
Update serializers.py
MoeSalah1999 d8a7f9a
Removed whitespace
MoeSalah1999 c4839ac
Removed blank line containing white space
MoeSalah1999 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
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'm not sure about this one... The previous version seemed simpler and clearer to me. The updated versions is more abstract and lacks the concrete example that was present before, which illustrates the "why" pretty well.
Not sure what other maintainers think, but I'd be in favour of reverting this part. Thoughts?
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.
@browniebroke Thanks for the feedback — that’s fair.
My intent with the rewrite was to make the docstring more explicit about what guarantees the helper provides and why writable nested writes are intentionally unsupported, especially for readers coming to this code without prior DRF context. That said, I agree the earlier concrete example does a very good job of illustrating the ambiguity in a way that’s immediately intuitive.
I’m happy to revert this section, or alternatively reintroduce the concrete example alongside the more structured explanation if that feels like a better balance. I don’t have a strong preference either way and would defer to what maintainers feel best fits the project’s documentation style.
Let me know what you’d prefer and I’ll update the PR accordingly.
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.
Good suggestion. Let's re-introduce the concrete example to illustrate, and then I'm hppy to accept it.
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.
Thanks for your insight, could you please verify this?