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 vote160 views1 answer
Python convert exponential to int
Python
73 votes155 views6 answers
Reverse the string in python
Python
0 vote262 views1 answer
Is_valid method django
Python
0 vote177 views2 answers
Get decimal value of char python
Python
0 vote156 views1 answer
Pandas df represent a long column name with short name
Python
17 votes161 views4 answers
Python pil resize image
Python
0 vote158 views1 answer
Merge multile dict
Python
0 vote169 views2 answers
Messagebox python pyqt
Python
0 vote161 views1 answer
Remove item from list python grepper
Python
0 vote153 views1 answer
How to make a number guessing game in python
Python