docstring python 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: python function docstring

def functionName():
    """
    This is a function docstring
    """

Example 3: docstrings in python

# Docstrings are used create your own Documentation for a function or for a class
# we are going to write a function that akes a name and returns it as a title.
def titled_name(name):
  # the following sting is Docstring
  """This function takes name and returns it in a title case or in other
  words it will make every first letter of a word Capitalized"""
  return f"{name}".title()

Example 4: python get function docstring

help(functionName)

Example 5: python docstring use

def function1():
   """
   :docstring- tells about program,what the program contains
   """