django-rest-framework-docs icon indicating copy to clipboard operation
django-rest-framework-docs copied to clipboard

Muliple line doc strings appearing as one

Open Aameer opened this issue 7 years ago • 6 comments

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.

class ProjectList(generics.ListAPIView):
    """
    * API Endpoint for Project List.
    * About API 2nd line:
        1.this is first point.
        2.this is second point. 
    """
    ...

mulipleline_docstring

But when we check it on the docs everything comes up in one line.

Aameer avatar Feb 28 '17 13:02 Aameer

Same issue.

csurbier avatar Mar 11 '17 21:03 csurbier

+1

realsby avatar Mar 12 '17 09:03 realsby

+1

dipaco avatar Aug 20 '17 03:08 dipaco

Hi,

Solved this issue by using this in my requirements.txt : git+https://github.com/manosim/django-rest-framework-docs.git

instead of pip install drfdocs. The package used by pip install is not up to date.

csurbier avatar Aug 20 '17 06:08 csurbier

@csurbier just did a preliminary test as per your suggestion and it seems to work . Thanks for sharing!

Aameer avatar Oct 12 '17 12:10 Aameer

Hmm it seems that didn't work for me.

ItsCalebJones avatar Apr 26 '18 20:04 ItsCalebJones