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 vote319 views1 answer
1d random walk in python stack exchange
Python
-1 vote284 views1 answer
Python data first column indices
Python
2 votes334 views2 answers
Fibonacci sequence python 2.7
Python
0 vote354 views1 answer
Plotly heatmap with label
Python
2 votes321 views1 answer
ValueError: Found array with dim 3. Estimator expected <= 2.
Python
2 votes325 views2 answers
Null=true django
Python Django
3 votes301 views1 answer
How to make a resizable pygame window
Python
-2 votes318 views1 answer
En_core_web_sm
Python
12 votes327 views2 answers
Python sigmoid function
Python
5 votes339 views2 answers
How to import tkinter in python
Python