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 vote130 views1 answer
Raise_for_status() requests
Python
2 votes140 views1 answer
Python text fromatting rows
Python
2 votes102 views1 answer
Dataframe to list of json
Python
0 vote153 views1 answer
Pendulum python
Python
0 vote136 views1 answer
Python warn vs warning
Python
0 vote98 views1 answer
Goto statement in python geeksforgeeks
Python
2 votes147 views1 answer
Python sort multiple lists based on sorting of single list
Python
4 votes155 views3 answers
Python difference in time
Python
0 vote99 views1 answer
How to get started with flask
Python
2 votes210 views1 answer
Python project tutorial
Python