question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Muliple line doc strings appearing as one

See original GitHub issue

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.

Issue Analytics

  • State:open
  • Created 7 years ago
  • Comments:6

github_iconTop GitHub Comments

1reaction
Aameercommented, Oct 12, 2017

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

0reactions
ItsCalebJonescommented, Apr 26, 2018

Hmm it seems that didn’t work for me.

Read more comments on GitHub >

github_iconTop Results From Across the Web

python - Docstrings - one line vs multiple line - Stack Overflow
The docstring for a function or method should summarize its behavior and document its arguments, return value(s), side effects, exceptions ...
Read more >
Multiline docstring in help with parameters and their descriptions
I'm using the latest version of Fire as of now and was wondering if it's possible to display a multiline docstring in help...
Read more >
PEP 257 – Docstring Conventions
Multi -line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate ......
Read more >
Highlighting of multi-line Python docstrings broken ... - GitLab
No tasks are currently assigned. Use tasks to break down this issue into smaller parts. Linked items. 1 ...
Read more >
Python Docstrings - Stack Abuse
Single -Line Docstrings​​ Mentioning which kind of value is returned to the caller helps to understand the result of the function or method. ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found