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 vote249 views1 answer
Tkinter radiobutton "bind_all"
Python
3 votes268 views2 answers
Python copy list
Python
0 vote248 views1 answer
If object has property python
Python
0 vote225 views1 answer
Python get item from set
Python
0 vote259 views2 answers
Turn list to string with commas python
Python
3 votes250 views1 answer
Python loop back to start
Python
0 vote234 views1 answer
Python skip input
Python
5 votes237 views2 answers
Python copy instance
Python
0 vote207 views1 answer
Django admin date format
Python
1 vote256 views1 answer
How to use git with python
Python