From 9399dd376fcae0ba5c82c9b4b7d312e6ecdc77bb Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:31:36 -0700 Subject: [PATCH 1/7] Change pip8 to flake8 --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b8aee81..d14002e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ Development process 2. Please follow the [commit message guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines) for each commit message. 3. Make sure to add tests! -4. Run `pep8` to ensure there are no lint errors. +4. Run `flake8` to ensure there are no lint errors. 5. `git push` your changes to GitHub. 6. Open a PR from your fork into the master branch of the original repo. @@ -34,13 +34,12 @@ Pull request acceptance criteria - Tests are located in `/tests` with one file per class. - Please don't change the `__version__`. We'll take care of bumping the version when we next release. -- Lint your code with PEP-8 before submitting. +- Lint your code with Flake8 before submitting. Style ----- -We enforce Flake8 rules with a few minor -[deviations](https://github.com/optimizely/python-sdk/blob/master/tox.ini). +We enforce Flake8 rules. License ------- From f541f6b8260147a1271ebb367f2c85eb57c45b51 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:35:44 -0700 Subject: [PATCH 2/7] Update contributing link to work in sphinx docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6192c567..48f29ca9 100644 --- a/README.md +++ b/README.md @@ -200,4 +200,4 @@ would be: ### Contributing -Please see [CONTRIBUTING](CONTRIBUTING.md). +Please see [CONTRIBUTING](https://github.com/optimizely/python-sdk/blob/master/CONTRIBUTING.md). From 28a271eb121aa42e87c9a029fadafc06ca9b7bb7 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:36:34 -0700 Subject: [PATCH 3/7] Remove Event Builder --- docs/source/api_reference.rst | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst index 6f3a60bf..b6f12115 100644 --- a/docs/source/api_reference.rst +++ b/docs/source/api_reference.rst @@ -4,22 +4,6 @@ Optimizely's APIs :members: -Event Builder -============= - -``Event`` ---------- - -.. autoclass:: optimizely.event_builder.Event - :members: - -``EventBuilder`` ----------------- - -.. autoclass:: optimizely.event_builder.EventBuilder - :members: - - Event Dispatcher ================ .. autoclass:: optimizely.event_dispatcher.EventDispatcher From 1837431502d8342a79b7587c41e3b15099bf4e7f Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:37:10 -0700 Subject: [PATCH 4/7] =?UTF-8?q?Change=20=E2=80=9CBucketing=20Algorithm=20M?= =?UTF-8?q?ethods=E2=80=9D=20to=20=E2=80=9CBucketing=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/bucketing_algorithm.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 2325522f..e793cd01 100644 --- a/docs/source/bucketing_algorithm.rst +++ b/docs/source/bucketing_algorithm.rst @@ -1,5 +1,5 @@ -Bucketing Algorithm Methods -=========================== +Bucketing +========= .. automodule:: optimizely.bucketer :members: From 8b37ecaea1db892e4e47586eb918fe7e76e3e818 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:37:55 -0700 Subject: [PATCH 5/7] Update project name --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 89097abf..08da5631 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- -project = 'Python SDK' +project = 'Optimizely Python SDK' copyright = '2016-2020, Optimizely, Inc' author = 'Optimizely, Inc.' version = __version__ From 27a25ea054d0099d528628cc807233d7c477f637 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 22 Apr 2020 14:38:48 -0700 Subject: [PATCH 6/7] Include README to table of contents --- docs/source/index.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index ba046b65..67a46059 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,10 @@ -Python SDK -========== +Optimizely Python SDK +===================== -.. mdinclude:: ../../README.md +.. toctree:: + :caption: Introduction + + readme .. toctree:: From 0163afbc93e48b8720d8437e208de43ae8b602d4 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Sun, 26 Apr 2020 14:06:20 -0700 Subject: [PATCH 7/7] Create readme.rst for readme.md --- docs/source/readme.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/source/readme.rst diff --git a/docs/source/readme.rst b/docs/source/readme.rst new file mode 100644 index 00000000..57de8658 --- /dev/null +++ b/docs/source/readme.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../README.md \ No newline at end of file