Skip to content

Commit 611dc54

Browse files
committed
Address readme feedback
1 parent 07f449d commit 611dc54

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ dashboard, please contact your Optimizely account executive.
3030
Using the SDK
3131
~~~~~~~~~~~~~
3232

33-
You can initialize the Optimizely instance in three ways: with a datafile, by providing an `sdk_key`, or by providing a Config Manager. Each method is described below.
33+
You can initialize the Optimizely instance in three ways: with a datafile, by providing an `sdk_key`, or by providing a `ConfigManager`_. Each method is described below.
3434

3535
1. Initialize Optimizely with a datafile. This datafile will be used as
3636
ProjectConfig throughout the life of Optimizely instance.
@@ -42,20 +42,18 @@ You can initialize the Optimizely instance in three ways: with a datafile, by pr
4242

4343
2. Initialize Optimizely by providing an 'sdk_key'. This will initialize
4444
a PollingConfigManager that makes an HTTP GET request to the URL (formed
45-
using your provided `sdk key` and the default datafile CDN url
45+
using your provided `sdk key` and the default datafile CDN URL
4646
template) to asynchronously download the project datafile at regular
4747
intervals and update ProjectConfig when a new datafile is recieved. A
4848
hard-coded datafile can also be provided along with the `sdk_key` that
4949
will be used initially before any update.
5050
::
5151

5252
optimizely.Optimizely(
53-
datafile=None,
5453
sdk_key='put_your_sdk_key_here'
5554
)
5655

57-
3. Initialize Optimizely by providing a Config Manager that implements a
58-
'get_config' method. You may use our `PollingConfigManager` as needed.
56+
3. Initialize Optimizely by providing a ConfigManager that implements `BaseConfigManager`_. You may use our `PollingConfigManager` as needed.
5957
::
6058

6159
optimizely.Optimizely(
@@ -112,7 +110,7 @@ datafile None Initia
112110

113111
A notification signal will be triggered whenever a *new* datafile is
114112
fetched and Project Config is updated. To subscribe to these
115-
notifications, use the
113+
notifications, use:
116114

117115
``notification_center.add_notification_listener(NotificationTypes.OPTIMIZELY_CONFIG_UPDATE, update_callback)``
118116

@@ -210,6 +208,8 @@ Please see `CONTRIBUTING`_.
210208
.. _Full Stack documentation: https://docs.developers.optimizely.com/full-stack/docs
211209
.. _Rollouts documentation: https://docs.developers.optimizely.com/rollouts/docs
212210
.. _CONTRIBUTING: CONTRIBUTING.rst
211+
.. _ConfigManager: https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py
212+
.. _BaseConfigManager: https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L32
213213

214214
.. |PyPI version| image:: https://badge.fury.io/py/optimizely-sdk.svg
215215
:target: https://pypi.org/project/optimizely-sdk

0 commit comments

Comments
 (0)