Commit f952a2ac7ba1a3de705bdb2a9e14d9e5066d3c5b

Authored by Adam Lockhart
1 parent 51780235

Updated documentation

Showing 1 changed file with 2 additions and 1 deletions   Show diff stats
1 ## ChangeDispenserController Class 1 ## ChangeDispenserController Class
  2 +Provides a simple API for the veding machine change dispenser.
2 3
3 ### Methods 4 ### Methods
4 #### calculateChange(unitsTendered, price) 5 #### calculateChange(unitsTendered, price)
@@ -7,7 +8,7 @@ @@ -7,7 +8,7 @@
7 8
8 **price:** Number. The units tendered match the currency for price, which is why price is just a number. 9 **price:** Number. The units tendered match the currency for price, which is why price is just a number.
9 10
10 -**Returns** true if change can succesfully be dispensed, otherwise returns false to issue a refund and cancel the product. 11 +**Returns** true if change will successfully be dispensed, otherwise returns false to issue a refund and cancel the product.
11 12
12 ## ChangeDispenser Class 13 ## ChangeDispenser Class
13 An instance of ChangeDispenser is programmed to physically know what change it has to dispense and physically how to dispense it. ChangeDispenser is a thin JavaScript layer over native code. 14 An instance of ChangeDispenser is programmed to physically know what change it has to dispense and physically how to dispense it. ChangeDispenser is a thin JavaScript layer over native code.