Demo Function: All fine
Description
This function is used for testing/demonstrating the DocConverter. Docstring all fine, properly includes a title, description, all arguments are documented as well as the (dummy) return and exceptions rased.
Usage
demofun_allfine(x='demo', *args, **kwargs)
Arguments
-
x
str
- Dummy input argument, defaults to “demo”.
-
*args
- Takes up all unnamed input arguments, unused.
-
**kwargs
- Takes up all named arguments, unused.
Return
str
: Simply returns x
at the end.
Raises
-
TypeError
: If argumentx
is not str.