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

11 votes257 views4 answers
Cv2 rgb to bgr
Python
40 votes300 views6 answers
Plt size
Python
2 votes229 views2 answers
How to replace a single letter in a string python
Python
0 vote215 views1 answer
Print from within funciton with multiprocessing
Python
0 vote191 views1 answer
Set constructor python
Python
34 votes268 views6 answers
Python if in list
Python
2 votes245 views3 answers
Streamlit pip
Python
3 votes192 views2 answers
Sort tuple by first element python
Python
0 vote230 views1 answer
Python timedelta get days with fraction
Python
0 vote201 views1 answer
How to make a nan value in a list
Python