Skip to content

Commit bd77995

Browse files
authored
docs: standardize on 'flags' not 'toggles' (#362)
1 parent 0d22d39 commit bd77995

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The UnleashClient constructor supports the following configuration options:
118118
| app_name | Name of the application using the client. Required. | None |
119119
| environment | Logical environment name (deprecated). | "default" |
120120
| instance_id | Unique identifier for this client instance. | "unleash-client-python" |
121-
| refresh_interval | How often to fetch feature toggles (seconds). | 15 |
121+
| refresh_interval | How often to fetch feature flags (seconds). | 15 |
122122
| refresh_jitter | Jitter to add to refresh interval (seconds). | None |
123123
| metrics_interval | How often to send metrics to Unleash (seconds). | 60 |
124124
| metrics_jitter | Jitter to add to metrics interval (seconds). | None |
@@ -139,13 +139,13 @@ The UnleashClient constructor supports the following configuration options:
139139

140140
### Bootstrap
141141

142-
By default, the Python SDK fetches your feature toggles from the Unleash API at startup. If you want to make your SDK more resilient (e.g., during network outages), you can bootstrap the client with a local or remote toggle config.
142+
By default, the Python SDK fetches your feature flags from the Unleash API at startup. If you want to make your SDK more resilient (e.g., during network outages), you can bootstrap the client with a local or remote toggle config.
143143

144144
How it works:
145145

146146
- Use a FileCache (or your own BaseCache implementation).
147147

148-
- Pre-seed it with feature toggles using bootstrap_from_dict, bootstrap_from_file, or bootstrap_from_url.
148+
- Pre-seed it with feature flags using bootstrap_from_dict, bootstrap_from_file, or bootstrap_from_url.
149149

150150
- Pass your cache to the UnleashClient on startup.
151151

@@ -321,7 +321,7 @@ client.is_enabled("testFlag")
321321

322322
### Custom cache
323323

324-
By default, the Python SDK stores feature toggles in an on-disk cache using fcache. If you need a different storage backend, for example, Redis, memory-only, or a custom database, you can provide your own cache implementation.
324+
By default, the Python SDK stores feature flags in an on-disk cache using fcache. If you need a different storage backend, for example, Redis, memory-only, or a custom database, you can provide your own cache implementation.
325325

326326
Below is an example custom CustomCache using fcache under the hood.
327327

@@ -364,7 +364,7 @@ client = UnleashClient(
364364

365365
## Running in multi-process setups
366366

367-
The Python SDK runs a background thread to keep feature toggles in sync with the Unleash server. Some runtime environments, like WSGI servers and Celery workers, need extra setup to make sure the SDK works correctly.
367+
The Python SDK runs a background thread to keep feature flags in sync with the Unleash server. Some runtime environments, like WSGI servers and Celery workers, need extra setup to make sure the SDK works correctly.
368368

369369
### WSGI
370370

@@ -379,7 +379,7 @@ See [The Art of Graceful Reloading](https://uwsgi-docs.readthedocs.io/en/latest/
379379

380380
### Celery
381381

382-
When using the SDK in Celery tasks, make sure you initialize it inside the worker_process_init event. Otherwise, the worker may run but won’t poll for feature toggle updates.
382+
When using the SDK in Celery tasks, make sure you initialize it inside the worker_process_init event. Otherwise, the worker may run but won’t poll for feature flag updates.
383383

384384
```python
385385
from UnleashClient import UnleashClient

0 commit comments

Comments
 (0)