documentation should be in this format ## 
#write a breif description of the method
# * *Args*    :
#   - +arg1+ -> a description for the argument
#   - +arg2+ -> a description for the argument
# * *Returns* :
#   - the sum of arg1 and arg2 as an integer
#