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

24 votes273 views7 answers
Python timer
Python
39 votes282 views5 answers
How to calculate the sum of a list in python
Python
-2 votes300 views6 answers
List comprehension in python
Python
0 vote348 views1 answer
Extract images from html page based on src attribute using beatutiful soup
Python
15 votes287 views1 answer
Function to a button in tkinter
Python
1 vote250 views1 answer
Check if pandas dataframe contains inf
Python
4 votes269 views3 answers
Python indexing
Python
1 vote285 views1 answer
Sort and remove duplicates list python
Python
6 votes298 views6 answers
Palindrome
Python
-1 vote310 views1 answer
Python dictionary print key value ascending order
Python