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
   """

Similar codes

0 vote301 views1 answer
How to make a password square multicolor square spiral python
Python
8 votes267 views4 answers
Create an array with same value python
Python
69 votes274 views6 answers
Python online compiler 3.8
Python
1 vote255 views1 answer
Pyo example
Python
1 vote310 views1 answer
Import * meaning in python
Python
0 vote284 views1 answer
Extract year from astype('datetime64[ns]')
Python
31 votes273 views2 answers
Python requests
Python
0 vote278 views1 answer
How to remove a list of numbers from a list in python
Python
1 vote261 views1 answer
File to lowercase python
Python
9 votes272 views1 answer
Drop the last row of a dataframe
Python