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

2 votes412 views1 answer
Django rest framework viewset perform_update
Python Django
4 votes324 views1 answer
Python spawn shell
Python
16 votes367 views3 answers
How to find total no of nan values in pandas
Python
24 votes301 views7 answers
Python timer
Python
0 vote330 views1 answer
Django MESSAGE_TAGS
Python
0 vote357 views1 answer
Python Hewwo wowwd
Python
1 vote350 views1 answer
User defined functions python
Python
2 votes315 views1 answer
Add values to tuple python
Python
10 votes318 views3 answers
Replace nan with mean
Python
24 votes353 views3 answers
Python open link in browser
Python