MyClass1

A whatever-you-are-doing.

param a:

The a of the system. Must be non-negative.

type a:

float

param b:

The b of the system.

type b:

float

my_first_ph3_package.MyClass1.my_string

A nice string.

Type:

str

raises ValueError:

If a is negative.

Notes

Document the __init__() method in the docstring of the class itself, because the docstring of the __init__() method does not appear in the documentation.

• Refer to a class this way: MyClass2 (except as a type indication, cf. update_b_from_class_2()).

• Refer to a method this way: addition().

• Refer to a method in another class: MyClass2.addition().

• Refer to an attribute this way: my_string.

• Refer to a property this way: a_square.

• Refer to a parameter or variable this way: a.

Examples

>>> my_object = MyClass1(a=5, b=3)