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

10 votes204 views3 answers
Gson
Python
5 votes209 views1 answer
Dataframe from arrays python
Python
1 vote203 views1 answer
Python get current number of threads
Python
0 vote292 views1 answer
Using a generic exception block
Python
0 vote202 views1 answer
Python Tkinter timer animation
Python
-2 votes234 views2 answers
Where to import reverse_lazy in django
Python Django
2 votes203 views2 answers
Replace nan numpy array
Python
3 votes225 views2 answers
Python initialize list
Python
0 vote228 views1 answer
Django Signup form
Python
0 vote211 views1 answer
Class inside class python
Python