encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-29 01:20:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Default SerializerMethodField's help_text to the docstring of the method.

Browse Source
This commit is contained in:
Noah Kantrowitz 2021-12-08 19:44:52 -08:00 committed by GitHub
parent c05998f5dd
commit 7a3d96d48a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
rest_framework/fields.py
View File

@ -1878,6 +1878,11 @@ class SerializerMethodField(Field):
# The method name defaults to `get_{field_name}`. # The method name defaults to `get_{field_name}`.
if self.method_name is None: if self.method_name is None:
self.method_name = 'get_{field_name}'.format(field_name=field_name) self.method_name = 'get_{field_name}'.format(field_name=field_name)
# If help_text isn't specified, try to get the method's docstring.
if self.help_text is None:
method = getattr(parent, self.method_name, None)
if method is not None:
self.help_text = method.__doc__
super().bind(field_name, parent) super().bind(field_name, parent)