From 3c933eaf4ede7ef4e83102ec0bc6b16bc84c7360 Mon Sep 17 00:00:00 2001
From: Blade Barringer <blade@crookedneighbor.com>
Date: Thu, 1 Oct 2015 12:31:08 -0500
Subject: [PATCH] Add comment to food file

---
 common/script/src/content/food/index.js | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/common/script/src/content/food/index.js b/common/script/src/content/food/index.js
index 537551ea87..5186831761 100644
--- a/common/script/src/content/food/index.js
+++ b/common/script/src/content/food/index.js
@@ -4,6 +4,29 @@ import {
   merge
 } from '../helpers';
 
+//--------------------------------------------------
+// Food are series objects that have defaults applied if not provided
+//
+// <food_key> : {
+//  key: <food_key>,
+//  text: t(food<formatted_key>),
+//  notes: t(foodNotes),
+//  article: <article>,
+//  target: <target_key>,
+//  value: <value>,
+//  canBuy: <canBuy_boolean>,
+//  canDrop: <canDrop_boolean>,
+// }
+//
+//  <food_key> is the name of the food
+//  <formatted_key> is a screeaming camelCase version of the key
+//  <article> is whether the food requires an indefinite article ('a', 'an', '')
+//  <target_key> is the potion key that this food targets
+//  <value> is the price of the food - defaults to 1
+//  <canBuy_boolean> is a boolean passed in as part of an options object
+//  <canDrop_boolean> is a boolean passed in as part of an options object
+//--------------------------------------------------
+
 import baseFood from './base';
 import saddle from './saddle';
 import cake from './birthday';