From ae3ae3487b8d9cefbeb92b340e608cdb3a6550c4 Mon Sep 17 00:00:00 2001
From: Andy Joslin <andytjoslin@gmail.com>
Date: Fri, 2 May 2014 08:09:11 -0600
Subject: [PATCH] docs(navClear): clarify how it works

Closes #1194
---
 js/angular/directive/navClear.js | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/js/angular/directive/navClear.js b/js/angular/directive/navClear.js
index 79588c05144..cf4c48894f8 100644
--- a/js/angular/directive/navClear.js
+++ b/js/angular/directive/navClear.js
@@ -6,13 +6,16 @@
  * @restrict AC
  *
  * @description
- * Disables any transition animations between views, along with removing the back
- * button which would normally show on the next view. This directive is useful for
- * links within a sideMenu.
+ * nav-clear is an attribute directive which should be used with an element that changes
+ * the view on click, for example an `<a href>` or a `<button ui-sref>`.
+ *
+ * nav-clear will cause the given element, when clicked, to disable the next view transition.
+ * This directive is useful, for example, for links within a sideMenu.
  *
  * @usage
- * Below is an example of a link within a side menu. Tapping this link would disable
- * any animations which would normally occur between views.
+ * Below is a link in a side menu, with the nav-clear directive added to it.
+ * Tapping this link will disable any animations that would normally occur
+ * between views.
  *
  * ```html
  * <a nav-clear menu-close href="#/home" class="item">Home</a>