From 65d89016b5ffe5250552c2cc936b3e541a4a2962 Mon Sep 17 00:00:00 2001
From: Brett Langdon <brett@blangdon.com>
Date: Thu, 28 Mar 2013 22:17:23 -0400
Subject: [PATCH] update api comments for search_api

---
 lib/api/search.js | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lib/api/search.js b/lib/api/search.js
index aca7e98..416110c 100644
--- a/lib/api/search.js
+++ b/lib/api/search.js
@@ -1,5 +1,15 @@
 var search_api = function(){};
 search_api.prototype.search = function(query, callback){
+    /*
+     * search_api.search(query, [callback])
+     *
+     * method used to query the api for `metrics` or `hosts`
+     *
+     * `query` the query to use to search the datadog service
+     *
+     * `callback` an optional function called with the results of the search
+     *     callback(error, result, status_code)
+    */
     this.request('GET', '/search', {query: {'q': query}}, callback);
 };