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 vote304 views1 answer
Python divide one column by another
Python
0 vote288 views1 answer
Qtablewidget clear python
Python
0 vote247 views1 answer
Pip offline package install
Python
1 vote285 views1 answer
Issue Pandas TypeError: no numeric data to plot
Python
0 vote255 views1 answer
Pygame image get height
Python
0 vote257 views3 answers
Ajouter dans une liste python
Python
7 votes286 views4 answers
How to count number of columns in dataframe python
Python
0 vote279 views2 answers
Def conditional_impute(input_df, choice='median')
Python
28 votes286 views6 answers
Docker compose command not found
Python
17 votes272 views3 answers
Python get current file location
Python