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 vote183 views1 answer
Reassign variable python
Python
0 vote191 views2 answers
How to refresh page in flask
Python
0 vote178 views1 answer
Add data to foreign key table django
Python Django
0 vote199 views1 answer
Check python version colab
Python
3 votes210 views1 answer
Add Border to input Pysimplegui
Python
0 vote188 views1 answer
Ensure string length 2 python
Python
1 vote239 views1 answer
Django httpresponseredirect
Python Django
2 votes183 views1 answer
Pandas convert all string columns to lowercase
Python
0 vote177 views1 answer
Import pygame module in pycharm
Python
0 vote271 views1 answer
Argumrnt with reverse django
Python Django