examples.sample_func.func#
- examples.sample_func.func(arg1, arg2)#
Summary line
. Extended description of function. Can span multiple lines and provides a general overview of the function.
Warning
Use the
.. warning::directive within the doc-string for any warnings you would like to explicitly state. For example, if this method will be deprecated in the next release.- Parameters:
- Returns:
- bool
Description of return value.
Examples
>>> func(1, 'foo') True