Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

ufc readme update#36

Merged
vpai merged 2 commits intomainfrom
update-readme
May 2, 2024
Merged

ufc readme update#36
vpai merged 2 commits intomainfrom
update-readme

Conversation

@vpai
Copy link
Contributor

@vpai vpai commented May 1, 2024

Using our new JS README as a base, I updated this README. You can view the updated version here. Looking for typos, thing of that nature.

📈 📈 📈

@vpai vpai requested review from aarsilv, giorgiomartini0 and schmit May 1, 2024 22:28
# Eppo Python SDK

## Getting Started
[![Test and lint SDK](https://github.com/Eppo-exp/python-sdk/actions/workflows/test-and-lint-sdk.yml/badge.svg)](https://github.com/Eppo-exp/python-sdk/actions/workflows/test-and-lint-sdk.yml)
Copy link
Contributor

Choose a reason for hiding this comment

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

nice!

@vpai vpai changed the title update readme update readme - ufc update May 2, 2024
@vpai vpai changed the title update readme - ufc update ufc readme update May 2, 2024
Copy link

@schmit schmit left a comment

Choose a reason for hiding this comment

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

Awesome updates!

README.md Outdated
Comment on lines +46 to +49
variation = eppoClient.get_boolean_assignment('show-new-feature', user.id, {
'country': user.country,
'device': user.device,
}, False)
Copy link

Choose a reason for hiding this comment

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

Nit: I think it's nicer if each argument gets a newline, otherwise the False is pretty hidden

README.md Outdated

Every Eppo flag has a return type that is set once on creation in the dashboard. Once a flag is created, assignments in code should be made using the corresponding typed function:

```javascript
Copy link

Choose a reason for hiding this comment

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

Suggested change
```javascript
```python

README.md Outdated
Every Eppo flag has a return type that is set once on creation in the dashboard. Once a flag is created, assignments in code should be made using the corresponding typed function:

```javascript
get_bool_assignment(...)
Copy link

Choose a reason for hiding this comment

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

Suggested change
get_bool_assignment(...)
get_boolean_assignment(...)

@vpai vpai force-pushed the update-readme branch from c8b0ae3 to 7ec9ea3 Compare May 2, 2024 23:24
@vpai vpai force-pushed the update-readme branch from 7ec9ea3 to c2dda2c Compare May 2, 2024 23:24
@vpai vpai merged commit 9985719 into main May 2, 2024
@vpai vpai deleted the update-readme branch May 2, 2024 23:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants