Python Docstrings Example

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)

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 votes234 views1 answer
Python method to check for uppercase character
Python
1 vote248 views1 answer
RuntimeError: Attempting to deserialize object on a CUDA device but torch.cuda.is_available()
Python
5 votes235 views1 answer
How to save to file in python
Python
0 vote245 views1 answer
ModuleNotFoundError: No module named 'html5lib'
Python
2 votes302 views3 answers
Dockerfile to run python script
Python
5 votes251 views2 answers
Python pandas drop column by index
Python
1 vote288 views1 answer
Flask api with parameter
Python Flask
2 votes258 views1 answer
Django.core.exceptions.ImproperlyConfigured
Python Django
157 votes259 views1 answer
Alphabet
Python
-2 votes245 views3 answers
Python substring count
Python