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

77 votes111 views6 answers
How to sort a dictionary by value in python
Python
0 vote115 views1 answer
Stackoverflow: install old version of networkx
Python
0 vote112 views2 answers
Which columns has null data?
Python
0 vote117 views2 answers
How to find the transpose of a matrix in python
Python
8 votes112 views1 answer
Python get actual timestamp
Python
44 votes117 views2 answers
Cm to foot
Python
0 vote113 views1 answer
Blender 2.8 python set active object
Python
2 votes111 views2 answers
Python replace only first instance
Python
0 vote127 views1 answer
How to delete all elements of a list in python
Python
0 vote131 views1 answer
Create python package ros 2
Python