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

0 vote222 views1 answer
Celery beat command for django celery beat
Python Django
0 vote232 views1 answer
No module named 'bootstrap4' django
Python Django
0 vote205 views1 answer
How to enable execution time in jupyter lab
Python
0 vote244 views3 answers
Python remove accents
Python
0 vote173 views1 answer
Cptac dataset
Python
0 vote166 views1 answer
Is dictreader scoped in python
Python
79 votes165 views6 answers
How to create a virtual environment in python 3
Python
36 votes171 views4 answers
Print colored text to console python
Python
1 vote186 views1 answer
Fill pixels with zeros python opencv
Python
0 vote163 views1 answer
Python pass string with spaces as argument
Python