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 vote133 views1 answer
Captain marvel subtitles subscene
Python
3 votes154 views2 answers
Initialise a 2d array python
Python
24 votes124 views4 answers
Select rows which have nan values python
Python
3 votes103 views2 answers
Otp generation in python
Python
1 vote115 views2 answers
Pygame collisions
Python
0 vote122 views1 answer
Networkx path between two nodes
Python
0 vote115 views1 answer
Reading a cell from another cell in colab
Python
10 votes118 views3 answers
Convert a dictionary into dataframe python
Python
7 votes115 views6 answers
What does enumerate do in python
Python
4 votes118 views1 answer
Softing a dict in pythno
Python