From f83022a444a775c773be0fd211c71bb04f936b59 Mon Sep 17 00:00:00 2001 From: Alexandre Stanislawski Date: Fri, 24 Mar 2017 16:03:20 +0100 Subject: [PATCH] feat(connector): update jsDoc descriptions --- src/connectors/price-ranges/connectPriceRanges.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/connectors/price-ranges/connectPriceRanges.js b/src/connectors/price-ranges/connectPriceRanges.js index ea5cfce6da..e8cb1c3e43 100644 --- a/src/connectors/price-ranges/connectPriceRanges.js +++ b/src/connectors/price-ranges/connectPriceRanges.js @@ -24,15 +24,15 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c /** * @typedef {Object} PriceRangesRenderingOptions - * @property {Object[]} items - * @property {function} refine + * @property {Object[]} items the prices ranges to display + * @property {function} refine select or unselect a price range and trigger a search * @property {Object} widgetParams all original options forwarded to rendering * @property {InstantSearch} instantSearchInstance */ /** * Connects a rendering function with the price ranges business logic. - * @param {function(PriceRangesRenderingOptions)} renderFn function that renders the price ranges widget + * @param {function(PriceRangesRenderingOptions, boolean)} renderFn function that renders the price ranges widget * @return {function(CustomPriceRangesWidgetOptions)} a widget factory for price ranges widget */ export default function connectPriceRanges(renderFn) {