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 vote318 views1 answer
Floating point python
Python
1 vote335 views1 answer
Python find string in list
Python
0 vote327 views1 answer
Qlistwidget item clicked event pyqt
Python
8 votes348 views2 answers
Get number of rows pandas
Python
26 votes362 views6 answers
Convert list of strings to ints python
Python
43 votes368 views6 answers
Create a dataframe python
Python
0 vote329 views1 answer
Drop nulll python
Python
0 vote384 views1 answer
Query dict immuteable
Python
6 votes327 views2 answers
Pygame size of image
Python
0 vote317 views4 answers
Newspaper pypi
Python