PEP 287 - reStructuredText docstrings examples

Handsdown API Index / Examples / PEP 287 - reStructuredText docstrings examples

Auto-generated documentation for examples.rst_docstrings module.

RSTExample

class RSTExample:
    ...

This is a reference for RST-style docstrings. Check source code to see how it works.

Type: str Return statement

Code example

data = {
    'key': 'value',
}

print(data)

@staticmethod
def reference():
    ...

Check if all attribute attributes, data and exception Exception in class RSTExample and class RSTExample look good.

@staticmethod
def replace_test():
    ...

:rtype: test.

Return statement Type: bool

@staticmethod
def rtype_test():
    ...