Merge pull request #1094 from algolia/fix/nameDesc

docs(widget): corrected sortBy values
algolia · Jun 14, 2016 · c343844 · c343844
2 parents 2c64340 + b69ffa5
commit c343844
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/_includes/widget-jsdoc/hierarchicalMenu.md b/docs/_includes/widget-jsdoc/hierarchicalMenu.md
@@ -33,7 +33,7 @@
 <span class='attr-optional'>`options.sortBy`<span class="show-description">…</span></span>
   <span class="attr-infos">Default:<code class="attr-default">[&#x27;name:asc&#x27;]</code>(<code>Array.&lt;string&gt;</code> &#124; <code>function</code>)</span>
 </p>
-<p class="attr-description">How to sort refinements. Possible values: `count|isRefined|name:asc|desc`</p>
+<p class="attr-description">How to sort refinements. Possible values: `count|isRefined|name:asc|name:desc`</p>
 <p class="attr-name">
 <span class='attr-optional'>`options.templates`<span class="show-description">…</span></span>
   <span class="attr-infos">(<code>Object</code>)</span>

diff --git a/docs/_includes/widget-jsdoc/menu.md b/docs/_includes/widget-jsdoc/menu.md
@@ -13,7 +13,7 @@
 <span class='attr-optional'>`options.sortBy`<span class="show-description">…</span></span>
   <span class="attr-infos">Default:<code class="attr-default">[&#x27;count:desc&#x27;, &#x27;name:asc&#x27;]</code>(<code>Array.&lt;string&gt;</code> &#124; <code>function</code>)</span>
 </p>
-<p class="attr-description">How to sort refinements. Possible values: `count|isRefined|name:asc|desc`</p>
+<p class="attr-description">How to sort refinements. Possible values: `count|isRefined|name:asc|name:desc`</p>
 <p class="attr-name">
 <span class='attr-optional'>`options.limit`<span class="show-description">…</span></span>
   <span class="attr-infos">Default:<code class="attr-default">10</code>(<code>string</code>)</span>

diff --git a/src/widgets/hierarchical-menu/hierarchical-menu.js b/src/widgets/hierarchical-menu/hierarchical-menu.js
@@ -22,7 +22,7 @@ let bem = bemHelper('ais-hierarchical-menu');
  * @param  {string} [options.rootPath] Prefix path to use if the first level is not the root level.
  * @param  {string} [options.showParentLevel=false] Show the parent level of the current refined value
  * @param  {number} [options.limit=10] How much facet values to get
- * @param  {string[]|Function} [options.sortBy=['name:asc']] How to sort refinements. Possible values: `count|isRefined|name:asc|desc`
+ * @param  {string[]|Function} [options.sortBy=['name:asc']] How to sort refinements. Possible values: `count|isRefined|name:asc|name:desc`
  * @param  {Object} [options.templates] Templates to use for the widget
  * @param  {string|Function} [options.templates.header=''] Header template (root level only)
  * @param  {string|Function} [options.templates.item] Item template, provided with `name`, `count`, `isRefined`, `url` data properties

diff --git a/src/widgets/menu/menu.js b/src/widgets/menu/menu.js
@@ -20,7 +20,7 @@ let bem = bemHelper('ais-menu');
  * @function menu
  * @param  {string|DOMElement} options.container CSS Selector or DOMElement to insert the widget
  * @param  {string} options.attributeName Name of the attribute for faceting
- * @param  {string[]|Function} [options.sortBy=['count:desc', 'name:asc']] How to sort refinements. Possible values: `count|isRefined|name:asc|desc`
+ * @param  {string[]|Function} [options.sortBy=['count:desc', 'name:asc']] How to sort refinements. Possible values: `count|isRefined|name:asc|name:desc`
  * @param  {string} [options.limit=10] How many facets values to retrieve
  * @param  {object|boolean} [options.showMore=false] Limit the number of results and display a showMore button
  * @param  {object} [options.showMore.templates] Templates to use for showMore