transmeaspy.my_module

Documentation about the TransMeasPy module.

Functions

hello(→ str)

Say hello.

Module Contents

transmeaspy.my_module.hello(name: str) → str

Say hello.

Function docstring using Google docstring style.

Parameters:

name (str) – Name to say hello to

Returns:

Hello message

Return type:

str

Raises:

ValueError – If name is equal to nobody

Example

This function can be called with Jane Smith as argument using

>>> from transmeaspy.my_module import hello
>>> hello('Jane Smith')
'Hello Jane Smith!'