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

2 votes149 views1 answer
Discord.py add role on member join
Python
3 votes159 views2 answers
Correlation analysis of dataframe python
Python
2 votes158 views1 answer
Pip vs anaconda venv
Python
16 votes1.7K views6 answers
Django forms
Python
0 vote169 views1 answer
True false array to black and white
Python
1 vote179 views1 answer
Python selenium partial class name
Python
0 vote151 views1 answer
Numpy fill with 0
Python
0 vote144 views1 answer
Python plot label value
Python
81 votes170 views6 answers
Python string to datetime
Python
8 votes189 views3 answers
Django order by
Python Django