Actions
Task #3958
closed
Viewset docstring written from developer perspective
Start date:
Due date:
% Done:
0%
Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:
Description
In numerous places throughout our codebase (and plugin codebase), we've written View and Viewset docstrings to contain developer information (e.g. [0]). We refer to classes and such in the docstring.
The problem is that DRF uses this docstring to fill in descriptions in the API. See:
http://www.django-rest-framework.org/topics/documenting-your-api/#documenting-your-views
Not really sure what the solution is but reading the API schema is confusing for users.
[0] https://gist.github.com/daviddavis/c44692ba1675be75c4e0dfed15c2fca0#file-gistfile1-txt-L3 comes from https://git.io/fAcub
Actions
.