docstring_templates module

docstring_templates.py

Short description for the file.

Functions and classes included in the file:

• simple_function

  Example for a simple function

• complex_function

  Example for a complex function

• ExampleClass

  Example of a class

class docstring_templates.ExampleClass

Bases: object

Short description.

Extended description.

attribute

Description

Type:

type

attribute

Description

Type:

type

method_short()

Description

method_long()

Description

Notes

Additional notes if required.

method_long(par_one, par_two)

Method description short.

Extended description.

Parameters:

• par_one (type) – Description

• par_two (type) – Description

Returns:

None – Description

Return type:

type

Notes

Additional notes if required.

method_short()

Method description short.

docstring_templates.complex_function(par_one, par_two)

Method description short.

Extended description.

Parameters:

• par_one (type) – Description

• par_two (type) – Description

Returns:

None – Description

Return type:

type

Notes

Additional notes if required.

docstring_templates.simple_function()

Simple one-line description.