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

4 votes231 views8 answers
Play solitaire
Python
1 vote202 views2 answers
Python regex get word after string
Python
3 votes275 views1 answer
Discord.py how to use permissions
Python
0 vote199 views1 answer
Pandas sequential numbering within group
Python
0 vote199 views1 answer
Discord.py get client avatar
Python
0 vote195 views1 answer
How to filter a series in pandas
Python
3 votes279 views6 answers
ImportError: Couldn't import Django. Are you sure it's installed and available on your PYTHONPATH environment variable? Did you forget to activate a virtual environment?
Python Django
0 vote187 views2 answers
Change value in excel using python
Python
14 votes227 views2 answers
Check dictionary is empty or not in python
Python
0 vote210 views2 answers
Matplotlib grid in background
Python