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 vote351 views1 answer
Python get weather temperature
Python
0 vote311 views1 answer
Mongodb check if substring in string
Python
117 votes355 views6 answers
Python how to get user input
Python
0 vote342 views1 answer
Python make an object hashable
Python
0 vote336 views1 answer
Jinja conditional syntax
Python
5 votes314 views4 answers
Ask a question on python
Python
0 vote347 views1 answer
Turn false true column into 0 1 pandas
Python
0 vote349 views1 answer
Light fm cold start problem
Python
5 votes302 views1 answer
Get hour in python
Python
0 vote394 views1 answer
Deezer python download
Python