Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Muliple line doc strings appearing as one #158

Open
Aameer opened this issue Feb 28, 2017 · 6 comments
Open

Muliple line doc strings appearing as one #158

Aameer opened this issue Feb 28, 2017 · 6 comments

Comments

@Aameer
Copy link

Aameer commented Feb 28, 2017

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.

@csurbier
Copy link

Same issue.

@realsby
Copy link

realsby commented Mar 12, 2017

+1

1 similar comment
@dipaco
Copy link

dipaco commented Aug 20, 2017

+1

@csurbier
Copy link

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.

@Aameer
Copy link
Author

Aameer commented Oct 12, 2017

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

@ItsCalebJones
Copy link

Hmm it seems that didn't work for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants