Last active
March 1, 2019 08:41
-
-
Save mbjelac/0910475d9064595fac97cd7cee7ef1e5 to your computer and use it in GitHub Desktop.
Comment type: User manual
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /* | |
| Carrot Soup Factory | |
| =================== | |
| This creates carrot soup. (Go figure!) | |
| ## API | |
| Parameters: | |
| amountOfCarrots: number - the amount of carrots | |
| amountOfOnions: number - the amount of onions | |
| amountOfSalt: number - the amount of salt in pinches | |
| Returns: object - a pot of carrot soup; object members: | |
| amount: number - liters | |
| temperature: number - celcius | |
| carrotSlices: number - amount of carrot slices | |
| saltiness: string - enum value of: BLAND, MILD, MEDIUM, STRONG, INEDIBLE | |
| tastiness: boolean - a flag indicating whether the soup is tasty or not | |
| ## Usage tips (TL;DR) | |
| The more carrots you put in, the more carrot slices you will have in the soup. | |
| The same goes for the salt. | |
| Tastiness depends on the overall combination of the amount of carrots, onions and salt. | |
| ## The art & science of a tasty carrot soup | |
| ... imagine an an essay on how to make a delicious carrot soup here ... | |
| */ | |
| function createCarrotSoup(amountOfCarrots, amountOfOnions, amountOfSalt) { | |
| // ... implementation ... | |
| } |
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
used in The World Of Comments: An Adventure