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 votes132 views1 answer
Fixed precision float python
Python
0 vote129 views1 answer
Numpy get length of list
Python
17 votes146 views2 answers
How to use headless browser in selenium python
Python
5 votes130 views1 answer
Reindexing Dataframe in Pandas
Python
4 votes140 views1 answer
Pygame music player
Python
1 vote125 views1 answer
Não nulo pandas
Python
0 vote135 views1 answer
Trim strings python
Python
0 vote141 views1 answer
Numpy datetime64 get day
Python
8 votes144 views4 answers
Check for missing values by column in pandas
Python
0 vote131 views2 answers
How to terminate a program cv2 python
Python