From 28e734676f33484ee5c6ae313fa62332affa79f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miroslav=20Bajto=C5=A1?= <miroslav@strongloop.com>
Date: Thu, 9 Jan 2014 16:22:58 +0100
Subject: [PATCH] docs: document remote method `description`

---
 docs/api-model-remote.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/api-model-remote.md b/docs/api-model-remote.md
index ae1255b1..1c30bdab 100644
--- a/docs/api-model-remote.md
+++ b/docs/api-model-remote.md
@@ -35,6 +35,7 @@ The options argument is a JSON object, described in the following table.
 | accepts   | No | Describes the remote method's arguments; See <a href="#argdesc">Argument description</a>. The `callback` argument is assumed; do not specify. |
 | returns    | No | Describes the remote method's callback arguments; See <a href="#argdesc">Argument description</a>. The `err` argument is assumed; do not specify. |
 | http | No | HTTP routing information: <ul><li> **http.path**: path (relative to the model) at which the method is exposed. May be a path fragment (for example, `/:myArg`) that will be populated by an arg of the same name in the `accepts` description. For example, the `stats` method above will be at the whole path `/products/stats`.</li><li> **http.verb**: HTTP method  (verb) from which the method is available (one of: get, post, put, del, or all).</li></ul>
+| description | No | A text description of the method. This is used by API documentation generators like Swagger.
 
 <a name="argdesc"></a>
 **Argument description**