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

1 vote161 views1 answer
Import numpy financial python
Python
3 votes152 views2 answers
Requests post with headers python
Python
0 vote150 views1 answer
Pandas convert hex string to int
Python
3 votes149 views2 answers
Distplot in python
Python
0 vote143 views2 answers
Handdle close window action in pyqt5
Python
0 vote162 views1 answer
Ipython and virtualenvs
Python
1 vote143 views2 answers
Python map list of int to string
Python
0 vote158 views1 answer
Python write into file at position
Python
41 votes198 views2 answers
If file exists delete python
Python
0 vote154 views1 answer
Webdriver.chrome() python not working
Python