Test file

test.my_func

def test.my_func(param0, param1=1.0) [source]

This is my function.

Parameters:	param0 : str This is parameter 0. param1 : float, default=1.0 This is parameter 1.
Returns:	None :

Examples

my_func('hello', 'world')

Out:

hello world

test.MyClass

class test.MyClass(param0, param1=None) [source]

This is my class.

Parameters:	param0 : str This is parameter 0. param1 : str or None, default=None This is parameter 1.
Attributes:	attr0 : str This is attribute 0. attr1 : str or None This is attribute 1.

Notes

This is a note.

Examples

x = MyClass('param0')
x.print_greeting()

Out:

hello world

Methods

print_greeting(self, name='world') [source]

This method returns a greeting.

Parameters:	name : str This is the name of the person to greet.
Returns:	greeting : str Of the form 'hello, {name}!'.