encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-05 04:50:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add help texts to ModelSerializer property fields

Browse Source 
If a field of a model wich is a read-only property is included in a ModelSerializer, automátically set its help text to the docstring of the property function. I used this to work with the documentation tool django-rest-swagger.
This commit is contained in:
Matías Lang 2015-10-30 18:35:52 -03:00
parent 119a073299
commit d1d0a78227
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
rest_framework/serializers.py
View File

@ -1160,7 +1160,7 @@ class ModelSerializer(Serializer):
Create a read only field for model methods and properties. Create a read only field for model methods and properties.
""" """
field_class = ReadOnlyField field_class = ReadOnlyField
field_kwargs = {} kwargs = {'help_text': getattr(model, field_name).__doc__}
return field_class, field_kwargs return field_class, field_kwargs