Sample Function¶
This will show the difference between different methods for showing documentation for functions
Sample Function (using automodule)¶
Functions:
|
This is a sample function which concatenates a and b (Google docstring format) |
|
This is a sample function which concatenates a and b (Numpy docstring format) |
- sample_function.sample_function_google(a, b)¶
This is a sample function which concatenates a and b (Google docstring format)
- Parameters
a (str) – Prefix of string
b (str) – Suffix of string
- Returns
Combined result of a and b
- Return type
str
- sample_function.sample_function_numpy(a, b)¶
This is a sample function which concatenates a and b (Numpy docstring format)
- Parameters
a (str) – Prefix of string
b (str) – Suffix of string
- Returns
Combined result of a and b
- Return type
str