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 vote329 views1 answer
Python align output
Python
1 vote341 views1 answer
_set in django
Python
5 votes338 views2 answers
Change index to dataframe pandas
Python
0 vote323 views1 answer
Pysimplegui get value from textbox
Python
1 vote370 views1 answer
How to print the text of varying length in python
Python
0 vote320 views1 answer
How to duplicate a row in python
Python
3 votes344 views3 answers
Python zip()
Python
0 vote335 views1 answer
Reportlab line thickness
Python
114 votes377 views5 answers
How to use inputs in python
Python
14 votes359 views6 answers
Python print variable
Python