Skip to content

Commit

Permalink
Fixing formatting (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
aliabbasrizvi committed Jul 26, 2019
1 parent 1e1051e commit 07e95f6
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ MANIFEST
# Output of building package
*.egg-info
dist
build/*

# Output of running coverage locally
cover
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
===============================
Optimizely Python SDK Changelog
===============================

3.2.0b1
-------

Expand Down
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
=====================
Optimizely Python SDK
=====================

Expand Down Expand Up @@ -30,7 +31,7 @@ dashboard, please contact your Optimizely account executive.
Using the SDK
~~~~~~~~~~~~~

You can initialize the Optimizely instance in three ways: with a datafile, by providing an `sdk_key`, or by providing an implementation of `config_manager.BaseConfigManager`_. Each method is described below.
You can initialize the Optimizely instance in three ways: with a datafile, by providing an `sdk_key`, or by providing an implementation of `BaseConfigManager`_. Each method is described below.

1. Initialize Optimizely with a datafile. This datafile will be used as
ProjectConfig throughout the life of Optimizely instance.
Expand All @@ -41,9 +42,9 @@ You can initialize the Optimizely instance in three ways: with a datafile, by pr
)

2. Initialize Optimizely by providing an 'sdk_key'. This will initialize
a PollingConfigManager that makes an HTTP GET request to the URL (formed
using your provided `sdk key` and the default datafile CDN URL
template) to asynchronously download the project datafile at regular
a PollingConfigManager that makes an HTTP GET request to the URL
(formed using your provided `sdk key` and the default datafile CDN URL template)
to asynchronously download the project datafile at regular
intervals and update ProjectConfig when a new datafile is received. A
hard-coded datafile can also be provided along with the `sdk_key` that
will be used initially before any update.
Expand Down Expand Up @@ -101,7 +102,7 @@ You may also provide your own logger, error_handler, or
notification_center.

Advanced configuration
''''''''''''''''''''''
''''''''''''''''''''''

The following properties can be set to override the default
configurations for `PollingConfigManager`.
Expand Down Expand Up @@ -216,7 +217,6 @@ Please see `CONTRIBUTING`_.
.. _Full Stack documentation: https://docs.developers.optimizely.com/full-stack/docs
.. _Rollouts documentation: https://docs.developers.optimizely.com/rollouts/docs
.. _CONTRIBUTING: CONTRIBUTING.rst
.. _config_manager.BaseConfigManager:: https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L32
.. _BaseConfigManager: https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L32

.. |PyPI version| image:: https://badge.fury.io/py/optimizely-sdk.svg
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
name='optimizely-sdk',
version=__version__,
description='Python SDK for Optimizely X Full Stack.',
long_description=about_text + '\n\n# Readme: \n' + README + '\n\n# Change Log: \n' + CHANGELOG,
long_description=about_text,
author='Optimizely',
author_email='developers@optimizely.com',
url='https://github.com/optimizely/python-sdk',
Expand Down

0 comments on commit 07e95f6

Please sign in to comment.