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()

Python get function docstring

help(functionName)

Docstring in python

"""The module's docstring"""

class MyClass:
    """The class's docstring"""

    def my_method(self):
        """The method's docstring"""

def my_function():
    """The function's docstring"""

Source: en.wikipedia.org

Python Docstrings Example

Python Docstrings Example
def Add(a,b):
    '''Takes two number as input and returns sum of 2 numbers'''
    return a+b

Source: itsmycode.com

Python docstring use

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

Similar codes

0 vote147 views2 answers
How to make a function input optional in python
Python
9 votes162 views6 answers
Df to np array
Python
3 votes194 views2 answers
How to create a label in python
Python
3 votes185 views1 answer
Python distance of coordinates
Python
3 votes143 views1 answer
Corr pandas
Python
1 vote144 views1 answer
Pandas pad method
Python
0 vote148 views1 answer
Expected a list of items but got type int . django
Python
0 vote165 views1 answer
Python bufferedreader
Python
0 vote231 views2 answers
Generate gif py
Python
0 vote149 views1 answer
Dt.weekday_name
Python