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 vote292 views1 answer
AttributeError: module 'pyarrow' has no attribute 'parquet'
Python
1 vote244 views1 answer
Minute range python
Python
5 votes271 views1 answer
Tf tensor from numpy
Python
7 votes275 views3 answers
Pandas replace nonetype with empty string
Python
0 vote270 views1 answer
Get Fiscal year
Python
17 votes269 views5 answers
Convert numpy array to tensor
Python
0 vote283 views1 answer
Tensorflow io check file exist
Python
0 vote258 views1 answer
Numpy is not nan
Python
2 votes260 views1 answer
Generate a list of random non repeated numbers python
Python
0 vote310 views1 answer
Check this id exist in database django
Python Django