mymodule.sample

Sample module, just used to demonstrate doc generation features.

Some additional test, just to check how it goes

Module Contents

Functions

get_random_ingredients(→ List[str])

Return a list of random ingredients as strings.

mymodule.sample.get_random_ingredients(kind: List[str] = None) → List[str]

Return a list of random ingredients as strings.

Parameters

kind (List[str] or None) – Optional “kind” of ingredients.

Raises

ValueError – If the kind is invalid.

Returns

The ingredients list.

Return type

List[str]