dissector.diffusion

Documentation about the dissector module.

Functions

hello(→ str)

Say hello.

Module Contents

dissector.diffusion.hello(name: str) → str

Say hello.

Function docstring using Google docstring style. Will be upgraded to sphinx style soon.

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 dissector.diffusion import hello
>>> hello('Jane Smith')
'Hello Jane Smith!'