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 vote243 views1 answer
Python args description multiple lines
Python
0 vote121 views1 answer
Django serializer exclude fields
Python
0 vote122 views1 answer
Split the string using the default arguments
Python
0 vote105 views1 answer
Tuple index in python
Python
1 vote111 views1 answer
Convert pandas dataframe to django queryset
Python
0 vote106 views1 answer
Pandas currency to numbe
Python
0 vote117 views1 answer
Dataframe print column comma separated
Python
2 votes112 views1 answer
Graph implementation in python
Python
2 votes128 views1 answer
Python remove empty folders
Python
1 vote109 views2 answers
Django print query
Python