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 vote126 views1 answer
Matplotlib show percentage y axis
Python
0 vote171 views1 answer
Dimension of an indez pandas
Python
0 vote132 views1 answer
Change between two python 3 version in raspberrry pi
Python
2 votes136 views1 answer
Fill zero behind number python
Python
0 vote106 views6 answers
Assign dictionary a value from a list python
Python
5 votes132 views1 answer
Python leap year solution
Python
2 votes120 views3 answers
How to reboot a python script
Python
9 votes93 views4 answers
Anagram
Python
3 votes129 views1 answer
How to find the multiples of a number in python
Python
0 vote123 views2 answers
I type nano in python and o get error
Python