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

0 vote193 views1 answer
Timestamp to date time till milliseconds python
Python
7 votes221 views2 answers
What is the django orm
Python Django
0 vote212 views1 answer
Count wit for loop pthoon
Python
2 votes138 views1 answer
Single line if else python
Python
1 vote234 views2 answers
Get user ip address django
Python Django
69 votes200 views4 answers
Iterate over df
Python
0 vote181 views1 answer
Opencv export image
Python
39 votes209 views4 answers
Round off float to 2 decimal places in python
Python
0 vote136 views1 answer
Border around dataframe in pandas
Python
-1 vote264 views1 answer
Django custom primary key field
Python Django