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

25 votes188 views5 answers
Python print timestamp
Python
2 votes256 views1 answer
Get last column pandas
Python
0 vote126 views1 answer
First rows of data frame (specify n by param)
Python
0 vote259 views1 answer
Django model custom field
Python Django
0 vote240 views1 answer
Spacy nlp load
Python
0 vote171 views1 answer
Python png to svg
Python
0 vote204 views1 answer
Python node class
Python
3 votes142 views1 answer
Colab cuda version
Python
0 vote211 views1 answer
Python increment filename by 1
Python
-1 vote199 views1 answer
How to bubble sort a 2d array in python
Python