PEP 287 - reStructuredText Docstring Format
Handsdown API Index / Examples / PEP 287 - reStructuredText docstrings examples
Auto-generated documentation for examples.rst_docstrings module.
Show source in rst_docstrings.py:10
class RSTExample: ...Show source in rst_docstrings.py:11
This is a reference for RST-style docstrings. Check source code
to see how it works.
my_param- Parameter exampletyped_paramint - Typed parameter example
Type: str Return statement
ValueError- Raises example
Code example
data = {
'key': 'value',
}
print(data)@staticmethod
def reference(): ...Show source in rst_docstrings.py:40
Check if all attribute attributes, data and exception Exception in
class RSTExample and class RSTExample look good.
@staticmethod
def replace_test(): ...Show source in rst_docstrings.py:31
:rtype: test.
Return statement Type: bool
@staticmethod
def rtype_test(): ...