"""An example module containing simplistic functions."""
[docs]
def greetings() -> str:
"""A friendly greeting for a future friend.
Example:
>>> greetings()
'Hello from LINCC-Frameworks!'
Note: this example becomes a unit test via doctests
Returns
-------
str
A typical greeting from a software engineer.
"""
return "Hello from LINCC-Frameworks!"
[docs]
def meaning() -> int:
"""The meaning of life, the universe, and everything.
Example:
>>> meaning()
42
Note: this example becomes a unit test via doctests
Returns
-------
int
The meaning of life.
"""
return 42