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 votes126 views2 answers
Run python script every hour
Python
0 vote133 views1 answer
Python remove middle of string
Python
2 votes170 views2 answers
Django request.data
Python Django
13 votes128 views3 answers
List remove method in python
Python
4 votes162 views5 answers
Module 'datetime' has no attribute 'now' django
Python Django
1 vote122 views1 answer
Django don't redirect on submission
Python
1 vote121 views1 answer
Split a variable into multiple variables in python
Python
12 votes142 views10 answers
Google
Python
2 votes139 views1 answer
Python assign list item in for loop
Python
0 vote123 views1 answer
Pandas look for values in column with condition
Python