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

2 votes393 views1 answer
Django create model from dictionary
Python Django
0 vote432 views2 answers
Find All Occurrences of a Substring in a String in Python
Python
0 vote341 views2 answers
Loading bar
Python
0 vote349 views1 answer
Long press selenium python
Python
0 vote380 views1 answer
Validationerror django params
Python Django
12 votes354 views3 answers
Matplotlib legend
Python
2 votes347 views2 answers
Numpy moving average
Python
0 vote334 views1 answer
Python regex replace point with underscore
Python
10 votes428 views1 answer
Pandas slice based on column value
Python
2 votes354 views2 answers
Or in django query
Python