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

1 vote227 views1 answer
Django gmail smtp
Python Django
4 votes215 views2 answers
Freq count in python
Python
7 votes206 views1 answer
First position dict python
Python
0 vote170 views1 answer
Error: getaddrinfo ENOTFOUND www.python.org www.python.org:443 Downloading Python failed. Error: { Error: getaddrinfo ENOTFOUND www.python.org www.python.org:443
Python
0 vote231 views3 answers
Find rules of decision tree python
Python
2 votes232 views1 answer
How to align text in tkinter
Python
0 vote202 views1 answer
Polyfit python
Python
25 votes197 views5 answers
Create an env in python
Python
17 votes240 views4 answers
How to install python 3.6 ubuntu
Python
20 votes205 views5 answers
List directory in python
Python