python method comments code example

Example 1: python comment

# This is a comment

""" This is a comment"""

"""
This is a comment
Also this is a comment
"""

Example 2: python comments

# Numpy-style python comments for functions
def foo(param_1=True):
  """Example function.

    Parameters
    ----------
    param_1 : bool, optional
        The first parameter (default is True)

    Returns
    -------
    num
        a number
    """
  return -1