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

20 votes331 views3 answers
Download image python
Python
7 votes338 views1 answer
Import excel file to python
Python
1 vote312 views1 answer
Fill na with mode and mean python
Python
0 vote324 views1 answer
Using python-poppler
Python
0 vote283 views1 answer
Count occurrences of one variable grouped by another python
Python
-4 votes352 views3 answers
Python read all text files in directory
Python
15 votes340 views6 answers
Python last element of list
Python
0 vote321 views1 answer
Python tkinter treeview get selected item
Python
12 votes323 views2 answers
Pil get image size
Python
0 vote331 views1 answer
Python - How To Check if a String Is a Palindrome
Python