From ee2134dcb7eaec7c358ab768f12000075e9b90c8 Mon Sep 17 00:00:00 2001
From: Blade Barringer <blade@crookedneighbor.com>
Date: Thu, 1 Oct 2015 12:30:51 -0500
Subject: [PATCH] Add comment to eggs file

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

diff --git a/common/script/src/content/eggs/index.js b/common/script/src/content/eggs/index.js
index a137ade6dd..ece3a7692f 100644
--- a/common/script/src/content/eggs/index.js
+++ b/common/script/src/content/eggs/index.js
@@ -1,5 +1,25 @@
 import {merge} from '../helpers';
 
+//--------------------------------------------------
+// Eggs are generated from an array of pet keys
+//
+// <egg_key> : {
+//  text: t(<type>Egg<egg_key>Text),
+//  mountText: t(<type>Egg<egg_key>MountText),
+//  notes: t(<type>Egg<egg_key>Text,{
+//    eggText: this.text,
+//    eggAdjective: t(<type>Egg<egg_key>Adjective)
+//  }),
+//  canBuy: <canBuy_boolean>,
+//  value: 3,
+//  key: <egg_key>,
+// }
+//
+//  <egg_key> is the name of the pet associated with the egg
+//  <type> is the type of egg (drop, quest, etc) passed in as part of an options object
+//  <canBuy_boolean> is a boolean passed in as part of an options object
+//--------------------------------------------------
+
 import dropEggs from './drops';
 import questEggs from './quest';