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

71 votes306 views6 answers
Alphabet list python
Python
0 vote265 views1 answer
Binarizer pyspark
Python
10 votes292 views2 answers
Python dict print keys
Python
0 vote323 views1 answer
Django create token for user
Python
0 vote303 views2 answers
Add key value in each dictonary in the list
Python
0 vote313 views1 answer
Random Hex Colors bar generator, python turtle
Python
7 votes312 views3 answers
Calculate the same value in list i python
Python
2 votes263 views3 answers
Horizontal bar plot matplotlib
Python
0 vote282 views2 answers
Url namespaces for django rest router urls
Python
2 votes288 views1 answer
How to start ftpd server with python
Python