Docstring in python

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
   """

-1

Similar codes

15 votes174 views5 answers
Join on column pandas
Python
0 vote177 views1 answer
Python string: .find()
Python
1 vote158 views1 answer
Python regex for a url
Python
1 vote160 views1 answer
Render_template not showing images
Python
1 vote168 views1 answer
Tabula python pdf to csv
Python
0 vote186 views1 answer
Flask server not reloading
Python Flask
0 vote163 views1 answer
Python remove \xa0
Python
18 votes175 views3 answers
Django-admin startproject
Python
5 votes178 views3 answers
Render to response django
Python Django
3 votes152 views1 answer
Python reciprocal
Python