Docstring in python

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
   """

-1

Similar codes

3 votes166 views2 answers
Extract one column from dataframe python
Python
72 votes212 views6 answers
Python compilers
Python
0 vote174 views1 answer
List loop get previous element
Python
12 votes183 views6 answers
Print()
Python
0 vote170 views1 answer
How to extract dictionary value from string in python
Python
0 vote162 views1 answer
Write dict to json file with special characters
Python
3 votes171 views1 answer
Selenium other item would revieve click
Python
1 vote198 views1 answer
Python delete first two indexes
Python
8 votes173 views1 answer
Negative lookbehind javascript
Python
3 votes182 views2 answers
Draw bounding box on image python cv2
Python