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 vote131 views1 answer
Np.random.randint to generate -1 +1
Python
0 vote134 views1 answer
Install python windows powershell
Python
0 vote120 views1 answer
Faire n fois la division d'un nombre python
Python
0 vote167 views1 answer
Django pointfield value format for fixtures
Python Django
-1 vote131 views1 answer
How to give values to all users with discord api python grepper
Python
2 votes174 views1 answer
Pyspark session
Python
0 vote182 views1 answer
Python multi-line statement
Python
0 vote164 views1 answer
ModuleNotFoundError: No module named 'rest_framework_social_oauth2'
Python
0 vote130 views1 answer
How to read xlsx file from one directory above python
Python
0 vote146 views1 answer
Dictionary Loop thru a dictionary's keys.
Python