Sample Class

This will show the difference between different methods for showing documentation for classes

Sample Class (using autoclass + autodocsumm)

class sample_class.SampleClass

Bases: object

Sample Class for demonstration

Methods:

func_add(a, b)	This is a sample function which adds a and b
func_concat(a, b)	This is a sample function which concatenates a and b
func_subtract(a, b)	This is a sample function which subtracts b from a

static func_add(a, b)

This is a sample function which adds a and b

Parameters

• a (int) – Number to add

• b (int) – Number to add

Returns

Addition of a and b

Return type

int

static func_concat(a, b)

This is a sample function which concatenates a and b

Parameters

• a (str) – Prefix of string

• b (str) – Suffix of string

Returns

Combined result of a and b

Return type

str

static func_subtract(a, b)

This is a sample function which subtracts b from a

Parameters

• a (int) – Number to subtract from

• b (int) – Number to subtract

Returns

Subtraction of b from a

Return type

int