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

1 vote297 views1 answer
Calculate integral python
Python
0 vote272 views1 answer
Histogram for categorical data with plotly
Python
0 vote249 views1 answer
What is iterator in python
Python
1 vote246 views1 answer
Python array append extend
Python
0 vote246 views1 answer
How to make an entire dataframe show in jupyter
Python
1 vote264 views1 answer
RuntimeError: Attempting to deserialize object on a CUDA device but torch.cuda.is_available()
Python
4 votes251 views3 answers
Unable to locate package python-pip
Python
0 vote271 views1 answer
What is primary key in python
Python
0 vote251 views1 answer
Comment transformer un chaine de caractere en liste python
Python
0 vote276 views2 answers
How to color label in pyqt5
Python