Document intentional discrepancies in allowlist & code comments #833
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
A few type hints are deliberately not aligned with implementation signatures. Document why this is.
This was referenced Sep 27, 2025
intgr
commented
Sep 27, 2025
| self, | ||
| child_relation: RelatedField = ..., | ||
| # DISCREPANCY: signature defaults `child_relation=None`, but actually crashes when `None` is provided. | ||
| child_relation: RelatedField, |
There was a problem hiding this comment.
The only functional change here -- removed the default value = ...
|
Merging myself as trivial change. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
A few type hints are deliberately not aligned with implementation signatures.
Documented why this is.
SlugRelatedField.slug_fieldtype: cannot beNone#830 (comment)emptyto be Enum #42