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

1 vote202 views1 answer
Try except python not working
Python
0 vote211 views1 answer
How to work with jupyterlab and conda environments
Python
0 vote241 views1 answer
How to keep old content when using write in python
Python
0 vote196 views2 answers
Style django forms with crisp
Python
0 vote190 views1 answer
C++ vs python
Python
0 vote187 views1 answer
Python turn list of strings into list of doubles
Python
14 votes219 views3 answers
Python int to bytes
Python
-1 vote240 views1 answer
Numpy arange number of elements
Python
0 vote216 views1 answer
Make a tuple
Python
2 votes244 views1 answer
All alphanumeric characters for python python
Python