Skip to content

Muliple line doc strings appearing as one  #158

@Aameer

Description

@Aameer

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions