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

3 votes316 views3 answers
Simple jwt django
Python
-3 votes295 views2 answers
Round robin
Python
11 votes285 views3 answers
Count repeat values in python list
Python
0 vote246 views1 answer
Fibonacci series in python using while loop
Python
3 votes270 views1 answer
Save clipboard data win32clipboard python
Python
0 vote285 views1 answer
Python googledriver download
Python
0 vote291 views1 answer
How to find the medium, first, second and third quartile in a pandas data frame
Python
1 vote272 views2 answers
Python3 shebang
Python
0 vote354 views1 answer
RuntimeError: Expected object of type torch.FloatTensor but found type torch.cuda.FloatTensor for argument
Python
2 votes273 views3 answers
Counter to df pandas
Python