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
   """

Similar codes

2 votes189 views3 answers
Condition python
Python
0 vote221 views1 answer
Listing of django model types
Python Django
0 vote207 views1 answer
Python interseciton of 2 sets
Python
10 votes196 views2 answers
Merge 2 dataframes in python
Python
2 votes202 views1 answer
Tensorflow reduce_sum
Python
4 votes209 views3 answers
No such table: django_session
Python
29 votes197 views6 answers
Get directory of file python
Python
1 vote198 views1 answer
Drop duplicate rows pandas except nan
Python
0 vote167 views0 answer
Python
79 votes177 views3 answers
Reverse element in a list in python 3
Python