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

1 vote208 views1 answer
Python cv2 imwrite
Python
4 votes214 views5 answers
Current time python
Python
10 votes198 views6 answers
Declaring variables in python
Python
0 vote196 views1 answer
Dictionary convert 2 lists into a dictionary, use zip()
Python
0 vote196 views1 answer
Proj 4.9.0 must be installed.
Python
1 vote229 views2 answers
How to remove the very last character of a text file in python
Python
2 votes179 views1 answer
Generate 12 random numbers python
Python
-1 vote222 views1 answer
Post an image Flask
Python Flask
5 votes164 views2 answers
Pyautogui move mouse
Python
0 vote200 views1 answer
Python [remote rejected] master -> master (pre-receive hook declined)
Python