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 vote276 views1 answer
Python - extract min and max values per each column name
Python
1 vote266 views1 answer
Python return specific elements from list
Python
2 votes247 views1 answer
Python numba
Python
70 votes258 views6 answers
Python alphabet list
Python
0 vote278 views1 answer
Dataframe how to substruct 2 dates
Python
10 votes275 views1 answer
Python turtle
Python
5 votes300 views3 answers
Python subplot space between plots
Python
1 vote243 views1 answer
Uniform distribution python example
Python
0 vote269 views1 answer
Django multi column index
Python
13 votes243 views1 answer
Selenium getting started
Python