help docstring code example
Example 1: python multiline docstring styles
def some_function(argument1):
"""Summary or Description of the Function
Parameters:
argument1 (int): Description of arg1
Returns:
int:Returning value
"""
return argument1
print(some_function.__doc__)
Example 2: function description in python
def mySum(a: float, b: float) -> float:
"""
mySum(a, b) Calculates the sum of two numbers
example: mySum(1.0, 2.0) -> 3.0
example: mySum(2.0, -1.5) -> 0.5
:param: a: First number
:param: b: Second Number
:returns: sum of first and second number
"""
return a+b