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

0 vote137 views1 answer
Allow Complex Number like "1+2j" to be treated as valid number
Python
0 vote97 views1 answer
Python float till 2 decimal places
Python
7 votes137 views3 answers
How to display data in ascending order in django
Python Django
1 vote104 views1 answer
Url decode python
Python
6 votes93 views1 answer
Save and load a dictionary python
Python
0 vote109 views1 answer
Mechanize python #4
Python
0 vote118 views1 answer
Integrate label into listbox tkinter
Python
62 votes154 views4 answers
Python wait 1 sec
Python
4 votes179 views4 answers
Change default python version
Python
4 votes100 views2 answers
Python list of dictionary unique
Python