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
How to alight and place ipywidgets
Python
1 vote227 views1 answer
How to capture an image with web cam open cv
Python
45 votes241 views6 answers
Get files in directory python
Python
3 votes187 views3 answers
Add items to list in python 3
Python
1 vote238 views3 answers
Python nested list
Python
0 vote237 views1 answer
How to copy file from local to sftp using python
Python
0 vote254 views1 answer
Django request.data example
Python
0 vote268 views1 answer
Flask remove file after send_file
Python Flask
0 vote224 views1 answer
Python random randint string
Python
-1 vote240 views1 answer
Histogram image processing python
Python