Document string : Doc String : Development PYTHON examples

PYTHON examples » Development » Doc String »

Document string



"""
Module documentation
Words Go Here
"""

spam = 40

def square(x):
    """
    function documentation 
    """
    return x **2

class employee:
    "class documentation"
    pass

print square(4)
print square.__doc__



import sys
help(sys.getrefcount)

help(sys)

help(dict)

help(str.replace)

help(ord)

help(docstrings.square)

def square(x):
     """
     function documentation
      ?
     """
     pass
    
help(docstrings.employee)

help(docstrings)