manosim / manosim/django-rest-framework-docs
Muliple line doc strings appearing as one
- Dominant language
- Python
- Stars
- 641
- Forks
- 178
- PR merge metrics
- No merged PRs in 30d
Description
If we have a class which has multiple line arguments. They appear on the same line. It would be great if we could format the doc string with some markup. Couldn't find anything related to formatting of doc string which is very important for any kind of documentation.
```python
class ProjectList(generics.ListAPIView):
"""
* API Endpoint for Project List.
* About API 2nd line:
1.this is first point.
2.this is second point.
"""
...
```

But when we check it on the docs everything comes up in one line.
Contributor guide
Research direction
No source file or test is named. Start by tracing how the example Python docstring is extracted and rendered in the documentation, using the linked screenshot as the expected problem. Done means multiline text, list items, and indentation remain readable as separate lines in the generated docs, with focused coverage for the rendering behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100