docs(connectors): fix spelling [STEP 8]

These are misc fixes in spelling that didn't exactly fit in a different PR remove small typo
algolia · Apr 15, 2019 · af38533 · af38533
1 parent 85f5f9c
commit af38533
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 11 deletions.
diff --git a/packages/react-instantsearch-core/src/connectors/connectAutoComplete.js b/packages/react-instantsearch-core/src/connectors/connectAutoComplete.js
@@ -101,10 +101,17 @@ export default createConnector({
     });
   },
 
-  /* connectAutoComplete needs to be considered as a widget to trigger a search if no others widgets are used.
-   * To be considered as a widget you need either getSearchParameters, getMetadata or getTransitionState
-   * See createConnector.js
-   * */
+  /**
+   * AutoComplete needs to be considered as a widget to trigger a search,
+   * even if no other widgets are used.
+   *
+   * To be considered as a widget you need either:
+   * - getSearchParameters
+   * - getMetadata
+   * - transitionState
+   *
+   * See: createConnector.tsx
+   */
   getSearchParameters(searchParameters, props, searchState) {
     return searchParameters.setQuery(
       getCurrentRefinement(props, searchState, {

diff --git a/packages/react-instantsearch-core/src/connectors/connectHits.js b/packages/react-instantsearch-core/src/connectors/connectHits.js
@@ -64,16 +64,17 @@ export default createConnector({
     return { hits: hitsWithPositionsAndQueryID };
   },
 
-  /* Hits needs to be considered as a widget to trigger a search,
+  /**
+   * Hits needs to be considered as a widget to trigger a search,
    * even if no other widgets are used.
    *
    * To be considered as a widget you need either:
    * - getSearchParameters
    * - getMetadata
-   * - getTransitionState
+   * - transitionState
    *
    * See: createConnector.tsx
-   * */
+   */
   getSearchParameters(searchParameters) {
     return searchParameters;
   },

diff --git a/packages/react-instantsearch/index.umd.js b/packages/react-instantsearch/index.umd.js
@@ -1,8 +1,9 @@
 /* eslint-disable */
 
-// This file exists only for the legacy UMD `Core` file. Sinc eRollup
+// This file exists only for the legacy UMD `Core` file. Since Rollup
 // is not able to correctly tree-shake the file we directly import the
-// exported file. It avoid to have a huge jump in filesize (8KB => 40 KB).
+// exported file. It avoid to have a huge jump in file size (8KB => 40 KB).
 
-// prettier-ignore
-export { default as createConnector } from 'react-instantsearch-core/dist/es/core/createConnector';
+export {
+  default as createConnector,
+} from 'react-instantsearch-core/dist/es/core/createConnector';