example_package.example

This is the module documentation. Can link to super_complex_operation(), Demo.run(), Demo.

Module Contents

Classes

Demo	Class-level documentation here.

Functions

super_complex_operation(x[, raise_error])	Prints the first argument.
simpler_function(x)	So much simple

example_package.example.super_complex_operation(x, raise_error=False)

Prints the first argument.

Parameters:

• x (obj) – Any arbitrary object that can be printed.

• raise_error (bool) – Just an argument to make it easy to break this function to demonstrate doctests.

example_package.example.simpler_function(x)

So much simple

class example_package.example.Demo(setup)

Bases: object

Class-level documentation here.

Docstring of the class

Parameters:

setup (str) – Arbitrary string

run()

Runs something.