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

3 votes284 views1 answer
Py change background
Python
0 vote322 views1 answer
Python OrderedDict - LRU
Python
-2 votes285 views1 answer
How to add all values in a list python without using sum function
Python
0 vote263 views1 answer
Def print_menu(): print{'1. Kilometers to Miles') print{'2. Miles to Kilometers'}
Python
0 vote286 views2 answers
Flask rest api upload image
Python
0 vote279 views1 answer
Python split string keep delimiter
Python
34 votes260 views6 answers
Class python example
Python
5 votes289 views6 answers
Convert int to binary python
Python
1 vote278 views1 answer
View whole dataset in python
Python
0 vote281 views1 answer
Sys.path.append python
Python