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

2 votes139 views1 answer
Sqlalchemy check if db exists
Python
11 votes171 views1 answer
Python check if int is between two values
Python
0 vote223 views1 answer
How to make loops in python
Python
0 vote227 views1 answer
Docker-compose.yml for flask celery rabbitmq
Python Flask
0 vote184 views1 answer
Python how to change a point in a multidimensional list
Python
1 vote213 views3 answers
Jsonresponse django
Python Django
25 votes180 views2 answers
Copy text to clipboard python
Python
0 vote177 views1 answer
Json python no whitespace
Python
0 vote198 views1 answer
Back of list
Python
0 vote187 views1 answer
Df select rows based on condition
Python