pydft.my_module

Documentation about the pydft module.

Module Contents

Functions

hello(name)

Say hello

pydft.my_module.hello(name)

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