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

42 votes328 views6 answers
If key in dictionary python
Python
0 vote350 views1 answer
I have two versions of python installed mac
Python
43 votes357 views1 answer
Python liste alphabaet
Python
0 vote321 views1 answer
Uninstalling/removing a package is very easy with pip:
Python
2 votes330 views1 answer
Flip a plot matplotlib
Python
0 vote391 views1 answer
Conditional Statements to Skip Items
Python
16 votes337 views6 answers
Python how to print
Python
-2 votes345 views1 answer
Start django project in windows
Python
0 vote332 views1 answer
String without space pythonm
Python
0 vote326 views1 answer
\n appears in json dump
Python