Skip to content

Removed Bucketing Algorithm Section and Added Description of Class Init Options in class Optimizely #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2020

Conversation

yavorona
Copy link
Contributor

Summary

  • Removed bucketing algorithm section including both sub sections since it is not public facing
  • Added description of various class init options in class Optimizely

Result:

image

Test plan

None

Issues

OASIS-6428

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.746% when pulling a3fe8cf on pnguen/OASIS-6428 into f8ee533 on sphinx-docs.

3 similar comments
@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.746% when pulling a3fe8cf on pnguen/OASIS-6428 into f8ee533 on sphinx-docs.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.746% when pulling a3fe8cf on pnguen/OASIS-6428 into f8ee533 on sphinx-docs.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 97.746% when pulling a3fe8cf on pnguen/OASIS-6428 into f8ee533 on sphinx-docs.

Copy link
Contributor

@aliabbasrizvi aliabbasrizvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@yavorona yavorona merged commit 4f84628 into sphinx-docs May 12, 2020
yavorona added a commit that referenced this pull request May 12, 2020
…it Options in class Optimizely (#259)

* Remove bucketing algorithm section

* Add __init__ to class optimizely.optimizely.Optimizely
yavorona added a commit that referenced this pull request May 14, 2020
…it Options in class Optimizely (#259)

* Remove bucketing algorithm section

* Add __init__ to class optimizely.optimizely.Optimizely
yavorona added a commit that referenced this pull request May 14, 2020
* Add docs.txt to requirements (#242)

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Create script to generate html docs with sphinx (#243)

* Create script to generate html docs with sphinx
Add minor changes to README.md and CONTRIBUTING.md for proper conversion to .rst

* Address comments

* Clean up

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Include docstrings from bucketer.py and decision_service.py to the docs (#244)

* Include docstrings from bucketer.py and decision_service.py to the docs

* Fix Travis failure

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Add docstrings from config_manager.py and optimizely_config.py to docs (#245)

Update buckering_algorithm to exclude namedtuble docstrings

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings to the docs (#246)

* Added optimizely.py to docs

* Returned to having private methods included for now.

* Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Added logger.py and user_profile.py docstrings to the docs. (#247)

* Added optimizely.py to docs

* Returned to having private methods included for now.

* Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs

* Added user_profile.py and logger.py docstrings to docs
Moved all api_reference components into one rst file

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Adding version of python sdk to docs (#249)

* Added optimizely.py to docs

* Returned to having private methods included for now.

* Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs

* Add version to docs

* Update branch

Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>

* Remove private methods (#250)

* Update sphinx docs per OASIS-6317 (#252)

* Change pip8 to flake8

* Update contributing link to work in sphinx docs

* Remove Event Builder

* Change “Bucketing Algorithm Methods” to “Bucketing”

* Update project name

* Include README to table of contents

* Create readme.rst for readme.md

* Add Optimizely logo to docs (#256)

* [OASIS-6317] - Fix README.md format (#255)

* Fix table in Advanced configuration

* Fix anchor

* Added README.md for generating sphinx docs (#257)

* Create README for sphinx docs

* Fix spelling

* Update README.md

Add title

* Incorporate Ali's comments

* chore(build): Making sure docs is excluded from build (#258)

* Removed Bucketing Algorithm Section and Added Description of Class Init Options in class Optimizely (#259)

* Remove bucketing algorithm section

* Add __init__ to class optimizely.optimizely.Optimizely

* Specified master_doc

Co-authored-by: Ali Abbas Rizvi <aliabbasrizvi@users.noreply.github.com>
@aliabbasrizvi aliabbasrizvi deleted the pnguen/OASIS-6428 branch May 14, 2020 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants