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

0 vote383 views1 answer
Email slicer in python code user input
Python
9 votes347 views1 answer
How to convert a set to a list in python
Python
4 votes338 views2 answers
Sklearn
Python
21 votes334 views2 answers
How to plot an array in python
Python
5 votes346 views4 answers
Pathlib get extension
Python
0 vote328 views1 answer
Moving element to the start ofa list python
Python
0 vote314 views1 answer
Range endpoint
Python
1 vote345 views2 answers
Django class based views
Python Django
0 vote343 views2 answers
Connect to mysql database jupyter
Python
63 votes346 views6 answers
What is a class in python
Python