Viewset docstring written from developer perspective
In numerous places throughout our codebase (and plugin codebase), we've written View and Viewset docstrings to contain developer information (e.g. ). 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:
Not really sure what the solution is but reading the API schema is confusing for users.
#6 Updated by email@example.com about 1 year ago
- Status changed from NEW to CLOSED - CURRENTRELEASE
This is still a problem, but it is spread out over many objects. I think the best thing to do is to close this and open issues for any autogenerated docs that don't make sense to the user. I am closing as a duplicate because it will be covered by the more specific issues.
Per object, the solution I've merged to pulp_python is to flag certain docstrings as user-facing docs. We can also add style using simple html tags. https://github.com/pulp/pulp_python/blob/4939808effd8a824452cc1798e6aac449be53cc4/pulp_python/app/viewsets.py#L143-L146
Please register to edit this issue