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 vote56 views0 answer
Python
79 votes103 views3 answers
Python join list to string
Python
16 votes105 views6 answers
Python how to print
Python
0 vote104 views1 answer
How to append substring to string in specific position in python
Python
10 votes91 views3 answers
Python infinite loop
Python
4 votes100 views1 answer
Eigenvectors python
Python
0 vote93 views1 answer
Draw a bow tie in python
Python
4 votes107 views2 answers
How to concat on the basis of particular columns in pandas
Python
0 vote115 views1 answer
What takes more memory string or list python
Python
0 vote96 views1 answer
Jointplot title
Python