#imports   $$ Comments that start with $$ in the following graphics are removable and strictly for explaining the graphic/workflow.


'''

   MISSION:  $$ To find xxxxxxxxxx

             $$ To measure xxxxxxxxxxxxx

             $$ To measure yyyyyyyyyyy

             $$ etc, etc.   Should be an overview of what you are doing, possibly include some measurements you'd like to find

'''




############################################################     ##########################################################
#                                                          #     #       BOXES SHOULD BE PLACED NEXT TO CODE              #
#               FUNCTION     DEFINITIONS                   #     #    TO EXPLAIN ALGORITHMS AND ABSTRACT IDEAS            #
#                                                          #     #                                                        #
############################################################     ##########################################################

#
#   FUNCTION DESCRIPTION / TYPES IN: foo OUT: bar             $$ types in and out are not required but help readability for humans.



                                                                # Comments should be brief
                                                                # Comments should start with a space followed by a capital letter
                                                                # Comments should be lined up horizontally, by section

                                                  # This set of comments is also acceptable because it's a separate section.
                                                  # They are also still lined up horizontally
                                                  # Relevant Comment



#####################################################################################################
#                                     NEEDED
#####################################################################################################
#
#                    $$   Description of functions needed for '''MISSION'''  that have yet to be written go here
#
#####################################################################################################
# NOTES:
#                    $$   NOTES and THOUGHTS to keep in mind HIGHLY IMPORTANT INFORMATION TAKES PRIORITY HERE.
#
#####################################################################################################
##                                  COMPLETE                                                        #
#####################################################################################################
#                                                                                                   #
#        Function Description                                 Function Name                         #
#####################################################################################################
#                   $$      COMPLETE FUNCTIONS GO HERE
#                                       |
#                                       |
#####################################################################################################


#  NEEDED and COMPLETE provide work flow. Once a function within NEEDED has been completed and tested, I send it to COMPLETE.
#  Once complete is filled out, we can move so that we are working below complete.
#  This allows us to see both notes and functions available without having to scroll through each.

#     $$    Once we have written our complete functions, we can scroll so that we are now working below that graphic,
#     $$    And we have a quick reference to functions available to us



#                                                                                                                                #
##      $$ This type of graphic is reserved for creating/initializing/assigning to data structures before doing any 'work'      ##
###                                                                                                                            ###


#
##    DO WORK // CREATE      $$ Reserved for sections of code that "builds" or manipulates data.
###                          $$ THESE SHOULD ALWAYS COME BELOW THE ABOVE, AND THE ABOVE INITIALIZATION GRAPHIC SHOULD NEVER BE BELOW THIS



#**************************************************************************************#
#                             GUI/OUTPUT                                               #
# $$This graphic is used to indicate all code below this will be related to the GUI    #







########################################################################
#  ERRORS:
#
#                   $$  Current Errors
#
#
########################################################################
#
#                         Error Fixes
#
#
#######################################################################
#
#
#     LOCATION:              $$ some_function()
#
#
#    ERROR INFO:             $$ returned int instead of str          $$ this allows you to track your own changes.
#
#
#    PREVIOUS CODE:          $$ return (int(x))
#
#
#    FIXED CODE:             $$ return (str(x))
#
#######################################################################