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.

Restructure all docstrings

See original GitHub issue

Restructure docstrings from:

class Foo(object):
    '''Blah blah.
    '''

… to …

class Foo(object):
    '''
    Blah blah.
    '''

It looks nicer.

Issue Analytics

State:
Created 7 years ago
Comments:9 (9 by maintainers)

Top GitHub Comments

1reaction

josiah-wolf-oberholtzercommented, Oct 20, 2016

If you want to keep helping, and want suggestions for what to look at, just ask. I’m trying to update many of the issues with better descriptions so people can determine how complex they are.

0reactions

kuretacommented, Oct 20, 2016

Thank you for starting such an awesome project. I will continue to do whatever I can. As I get more familiar with the code I hope to be more useful.

Top Results From Across the Web

PEP 287 – reStructuredText Docstring Format

Through its docstring syntax, Python allows us to document our code from within. ... reStructuredText meets and exceeds all of these goals, ......

2. Example on how to document your Python docstrings

This code will scan the module template.py, find all its members, undocumented members and add their docstrings. It will also include documentation from...

Simple way to convert Python docstrings from reStructured ...

Try using pyment to convert docstrings from reStructuredText to Google format. Then use Napolean to generate documentation via Sphinx.

Specify types with docstrings | PyCharm Documentation

PyCharm creates a documentation stub, according to the selected docstring format, ... Note that reStructuredText is used for all the subsequent examples, ......

Python Docstrings: Reference & Examples - queirozf.com

Examples to help you document your Python code using any of the commonly used docstring styles.