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

4 votes224 views1 answer
List of df to df
Python
16 votes218 views6 answers
Python print function
Python
0 vote229 views1 answer
How to set time.sleep(2) on instapy
Python
6 votes236 views4 answers
Get channel from id discord.py
Python
1 vote249 views1 answer
Python extraer primer elemento lista
Python
0 vote242 views1 answer
Long to_bytes python how to use it
Python
70 votes245 views6 answers
What is python virtual environment
Python
0 vote225 views1 answer
Place legend on location matplotlib
Python
0 vote232 views1 answer
Timeout python
Python
0 vote264 views4 answers
Read file from google drive colab
Python