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.

Sign up for GitHub

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

Jump to bottom

Ensure all SerializerMethodFields are appropriately documented #2968

Closed
jeremystretch opened this issue Mar 5, 2019 · 0 comments
Closed

Ensure all SerializerMethodFields are appropriately documented #2968

jeremystretch opened this issue Mar 5, 2019 · 0 comments
Assignees
@jeremystretch
Labels
status: accepted This issue has been accepted for implementation type: bug A confirmed report of unexpected behavior in the application
Milestone
v2.6

Comments

@jeremystretch
Copy link
Member

Proposed Changes

We use SerializerMethodFields for some serializer fields with unique requirements. We should try to replace these with actual serializers, or at least ensure that they are properly documented.

Justification

This was identified as an area for improvement during the discussion under #2665.
@jeremystretch jeremystretch added status: accepted This issue has been accepted for implementation type: housekeeping Changes to the application which do not directly impact the end user labels Mar 5, 2019
@jeremystretch jeremystretch mentioned this issue Mar 5, 2019
Closed
@jeremystretch jeremystretch added this to the v2.6 milestone Mar 6, 2019
@jeremystretch jeremystretch self-assigned this Mar 7, 2019
@jeremystretch jeremystretch added type: bug A confirmed report of unexpected behavior in the application and removed type: housekeeping Changes to the application which do not directly impact the end user labels Mar 8, 2019
jeremystretch added a commit that referenced this issue Mar 8, 2019
@jeremystretch
Fixes #2968: Correct API documentation for SerializerMethodFields
d9c8c0c
@mraerino mraerino mentioned this issue Apr 30, 2019
Closed
@jeremystretch jeremystretch mentioned this issue Jun 20, 2019
Merged
@lock lock bot locked as resolved and limited conversation to collaborators Jan 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jeremystretch jeremystretch

Labels
status: accepted This issue has been accepted for implementation type: bug A confirmed report of unexpected behavior in the application
Projects
None yet
Milestone
v2.6
Development

No branches or pull requests
1 participant
@jeremystretch