example.mod_a

source module example.mod_a

Module A.

Classes

• ClassA — Class A.

Functions

• func_a — Function A.

• sum_and_product — Computes the sum and product of two integers

source class ClassA(a: str)

Class A.

Parameters

• a : str — A string.

Attributes

• attr_a : str — Attribute A.

Methods

• method_a — Method A. Return ClassA.

source method ClassA.method_a(x: Iterable[str], y: ClassB) → ClassA

Method A. Return ClassA.

Parameters

• x : Iterable[str] — An iterable of strings.

• y : ClassB — An instance of ClassB.

Returns

• ClassA — An instance of ClassA.

Raises

• ValueError

source func_a(x: int) → int

Function A.

Parameters

• x : int — An integer.

Returns

• int — An integer.

See Also

• ClassA.method_a
• ClassB.method_b
• func_b

source sum_and_product(x, y)

Computes the sum and product of two integers

Parameters

• x : int

• y : int

Returns

• s : int — sum of x and y

• p : int — product of x and y