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 vote103 views1 answer
Cursor.fetchall() to list
Python
0 vote59 views2 answers
Nested renamer is not supported pandas
Python
8 votes127 views3 answers
Async sleep python
Python
9 votes106 views3 answers
How to join tables in python
Python
-1 vote100 views1 answer
Print(shahzaib)
Python
1 vote122 views1 answer
Show jpg in jupyter notebook
Python
11 votes103 views4 answers
How to make a qr code generator in python
Python
0 vote101 views1 answer
Dont truncate dataframe jupyter pd display options
Python
-1 vote96 views1 answer
Python remove \t
Python
40 votes99 views3 answers
Python push to dataframe pandas
Python