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 vote235 views4 answers
Join tables in django orm
Python Django
0 vote226 views1 answer
Python interpreter pip
Python
0 vote209 views2 answers
Round to nearest multiple of 5 python from both end
Python
0 vote201 views1 answer
S3 pre signed url python
Python
5 votes219 views2 answers
Python calc days between dates
Python
28 votes154 views7 answers
Anagram python
Python
0 vote204 views1 answer
Ipynb to py online
Python
0 vote200 views1 answer
Pandas change order of columns in multiindex
Python
4 votes207 views3 answers
Flash messages django
Python Django
0 vote206 views1 answer
Start virtualenv with python version
Python