Skip to content

Commit c1803ca

Browse files
Update comment regarding factory and config props in SplitFactoryProvider
1 parent 2296052 commit c1803ca

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/SplitFactoryProvider.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ import { DEFAULT_UPDATE_OPTIONS } from './useSplitClient';
1111
* and automatically destroy the SDK (shutdown and release resources) when it is unmounted or `config` prop updated. SplitFactoryProvider must wrap other library components and
1212
* functions since they access the Split Context and its properties (factory, client, isReady, etc).
1313
*
14-
* NOTE: Either pass a factory instance or a config object. If both are passed, the config object will be ignored.
15-
* Pass the same reference to the config or factory object rather than a new instance on each render, to avoid unnecessary props changes and SDK reinitializations.
14+
* NOTE: Either pass a `factory` instance or a `config` object as props. If both props are passed, the `config` prop will be ignored.
15+
* Pass the same reference to the `config` or `factory` object rather than a new instance on each render, to avoid unnecessary props changes and SDK reinitializations.
1616
*
1717
* @see {@link https://help.split.io/hc/en-us/articles/360038825091-React-SDK#2-instantiate-the-sdk-and-create-a-new-split-client}
1818
*/

0 commit comments

Comments
 (0)