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 vote200 views3 answers
Create a Tuple
Python
1 vote191 views1 answer
How to make simple login in python
Python
0 vote174 views1 answer
Predict probabilities with xg boost
Python
1 vote222 views2 answers
Run flask in background
Python Flask
0 vote184 views2 answers
Os
Python
5 votes190 views4 answers
Pathlib get extension
Python
3 votes188 views6 answers
Pandas count specific value in column
Python
3 votes182 views2 answers
Python dataframe column string to integer python
Python
0 vote192 views1 answer
Mad libs generator python tutorial
Python
10 votes182 views3 answers
Write json pythonb
Python