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

0 vote141 views1 answer
Python selenium firefox handle ssl bypass
Python
16 votes159 views6 answers
Python how to print
Python
3 votes140 views3 answers
Pandas merge two dataframes remove duplicates
Python
0 vote132 views1 answer
Pandas select only earliest event for duplicates
Python
3 votes137 views1 answer
How to change window size in kivy python
Python
5 votes160 views3 answers
Get input from user in python
Python
4 votes133 views2 answers
Sum of array using recursion in python
Python
1 vote139 views2 answers
Difference between == and is
Python
0 vote140 views1 answer
Python multiline code dot
Python
19 votes139 views3 answers
Python program to check whether a number is even or odd
Python