Polishing

EmilianoSanchez · EmilianoSanchez · commit 50b50282f3a3 · 2024-02-02T11:16:13.000-03:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,6 +1,6 @@
 1.11.0 (January 16, 2023)
  - Added new `SplitFactoryProvider` component as a replacement for the now deprecated `SplitFactory` component.
-      - Bugfixing: The new component is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle,
+      - Bugfixing: The new component is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle,
            - resolving memory leak issues in React development mode, strict mode and server-side rendering (Related to issues #11 and #109),
            - and also ensuring that the SDK is updated if `config` or `factory` props change (Related to issues #11 and #148).
       - Notable changes when migrating from `SplitFactory` to `SplitFactoryProvider`:
diff --git a/MIGRATION-GUIDE.md b/MIGRATION-GUIDE.md
@@ -2,7 +2,7 @@
 
 The `SplitFactory` and `withSplitFactory` components have been deprecated since React SDK v1.11.0, and will be removed on a future major release.
 
-We recommend migrating to the new `SplitFactoryProvider` component instead. This component is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle, resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
+We recommend migrating to the new `SplitFactoryProvider` component instead. This component is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle, resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
 
 Notable changes to consider when migrating:
  - `SplitFactoryProvider` utilizes the React Hooks API, requiring React 16.8.0 or later, while `SplitFactory` is compatible with React 16.3.0 or later.
diff --git a/src/SplitFactory.tsx b/src/SplitFactory.tsx
@@ -16,7 +16,7 @@ import { DEFAULT_UPDATE_OPTIONS } from './useSplitClient';
  *
  * @deprecated `SplitFactory` will be removed in a future major release. We recommend replacing it with the new `SplitFactoryProvider` component.
  *
- * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle,
+ * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle,
  * resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
  *
  * Notable changes to consider when migrating:
diff --git a/src/withSplitFactory.tsx b/src/withSplitFactory.tsx
@@ -12,7 +12,7 @@ import { SplitFactory } from './SplitFactory';
  *
  * @deprecated `withSplitFactory` will be removed in a future major release. We recommend replacing it with the new `SplitFactoryProvider` component.
  *
- * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle,
+ * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle,
  * resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
  *
  * Notable changes to consider when migrating:

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import { DEFAULT_UPDATE_OPTIONS } from './useSplitClient';`
`16`	`16`	`*`
`17`	`17`	* @deprecated `SplitFactory` will be removed in a future major release. We recommend replacing it with the new `SplitFactoryProvider` component.
`18`	`18`	`*`
`19`		- * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle,
	`19`	+ * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle,
`20`	`20`	* resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
`21`	`21`	`*`
`22`	`22`	`* Notable changes to consider when migrating:`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import { SplitFactory } from './SplitFactory';`
`12`	`12`	`*`
`13`	`13`	* @deprecated `withSplitFactory` will be removed in a future major release. We recommend replacing it with the new `SplitFactoryProvider` component.
`14`	`14`	`*`
`15`		- * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (factory creation and destruction) within the React component lifecycle,
	`15`	+ * `SplitFactoryProvider` is a revised version of `SplitFactory` that properly handles SDK side effects (i.e., factory creation and destruction) within the React component lifecycle,
`16`	`16`	* resolving memory leak issues in React development mode, strict mode and server-side rendering, and also ensuring that the SDK is updated if `config` or `factory` props change.
`17`	`17`	`*`
`18`	`18`	`* Notable changes to consider when migrating:`