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 vote292 views1 answer
Keras import optimizer adam
Python
0 vote269 views1 answer
How to iterate a dictionary with minimum value in python
Python
0 vote295 views1 answer
Feature importance plot
Python
0 vote272 views1 answer
Can only use .str accessor with string values!
Python
1 vote291 views1 answer
Python print percent sign
Python
13 votes273 views2 answers
How to append to text file with new line by line in python
Python
0 vote261 views1 answer
Python class destroying
Python
18 votes275 views9 answers
While loop
Python
-1 vote318 views1 answer
First n prime number finder in python
Python
1 vote316 views1 answer
Make new app folder in django templates dir
Python Django