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 vote308 views1 answer
Write a function to split a string and convert it into an array of words.
Python
0 vote354 views2 answers
A guide to numpy and pandas
Python
29 votes328 views3 answers
For x in range(1,100, 10): print(x)
Python
0 vote337 views1 answer
Turn of warning iin python
Python
7 votes365 views4 answers
Numpy normalize
Python
0 vote353 views1 answer
Python check samplerate of mp3
Python
158 votes429 views3 answers
Traversing dictionary in python
Python
1 vote331 views1 answer
Left join outer apply
Python
41 votes361 views6 answers
How to remove rows with nan in pandas
Python
0 vote352 views1 answer
Tqdm pandas apply
Python