PEP 257 - PEP 257 and Google docstrings examples

Handsdown API Index / Examples / PEP 257 - PEP 257 and Google docstrings examples

Auto-generated documentation for examples.pep257_docstrings module.

ClassExample

PEP257-style class example

Example of a code block

You can use ~~~ to start a block as well

MD block example inside a tilde block

```python
This is not a codeblock, test inside tildes rendered as it is
```

class ClassExample:
    ...

Summary line.

Extended description of method.

Examples should be written in doctest format, and should illustrate how to use the function.

>>> print([i for i in
... example_generator(2)])
[
    'one',
    'two',
]

>>> setup_env()
>>> func_call(
...     first_name='test',
...     last_name='test',
... )

Description of return value

def method_example(self, text: str = "hello") -> int:
    ...

Form a complex number.

def function_example(real=0.0, imag=0.0):
    ...