Skip to content

Commit 01d196d

Browse files
committed
removed changes for doc/source/introduction.rst
1 parent f80b48d commit 01d196d

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

doc/source/introduction.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following snippet shows you how to create a basic client using the default c
2626
>>> from splitio import get_factory
2727
>>> factory = get_factory('some_api_key')
2828
>>> client = factory.client()
29-
>>> client.get_treatment('some_user', 'some_feature_flag')
29+
>>> client.get_treatment('some_user', 'some_feature')
3030
'SOME_TREATMENT'
3131

3232
Bucketing key
@@ -39,11 +39,11 @@ In advanced mode the key can be set as two different parts, one of them just to
3939
>>> split_key = Key(user, bucketing_key)
4040
>>> factory = get_factory('API_KEY')
4141
>>> client = factory.client()
42-
>>> client.get_treatment(split_key, 'some_feature_flag')
42+
>>> client.get_treatment(split_key, 'some_feature')
4343

4444
Manager API
4545
-----------
46-
Manager API is very useful to get a representation (view) of cached feature flags: ::
46+
Manager API is very useful to get a representation (view) of cached splits: ::
4747

4848
>>> from splitio import get_factory
4949
>>> factory = get_factory('API_KEY')
@@ -57,7 +57,7 @@ Available methods:
5757
**split(name):** Returns a SplitView instance ::
5858
>>> manager.split('some_test_name')
5959

60-
**split_names():** Returns a list of Feature Flag names (String) ::
60+
**split_names():** Returns a list of Split names (String) ::
6161
>>> manager.split_names()
6262

6363
Client configuration
@@ -79,7 +79,7 @@ All the possible configuration options are:
7979
+------------------------+------+--------------------------------------------------------+---------+
8080
| readTimeout | int | The read timeout for HTTP connections in milliseconds. | 1500 |
8181
+------------------------+------+--------------------------------------------------------+---------+
82-
| featuresRefreshRate | int | The feature flags update refresh period in | 5 |
82+
| featuresRefreshRate | int | The features (splits) update refresh period in | 5 |
8383
| | | seconds. | |
8484
+------------------------+------+--------------------------------------------------------+---------+
8585
| segmentsRefreshRate | int | The segments update refresh period in seconds. | 60 |
@@ -88,10 +88,10 @@ All the possible configuration options are:
8888
+------------------------+------+--------------------------------------------------------+---------+
8989
| impressionsRefreshRate | int | The impressions report period in seconds | 60 |
9090
+------------------------+------+--------------------------------------------------------+---------+
91-
| ready | int | How long to wait (in milliseconds) for the feature | |
92-
| | | flags and segments information to be available. If | |
93-
| | | the timeout is exceeded, a ``TimeoutException`` will | |
94-
| | | be raised. If value is 0, the constructor will return | |
91+
| ready | int | How long to wait (in milliseconds) for the features | |
92+
| | | and segments information to be available. If the | |
93+
| | | timeout is exceeded, a ``TimeoutException`` will be | |
94+
| | | raised. If value is 0, the constructor will return | |
9595
| | | immediately but not all the information might be | |
9696
| | | available right away. | |
9797
+------------------------+------+--------------------------------------------------------+---------+
@@ -106,31 +106,31 @@ directory. The ``.split`` file has the following format: ::
106106

107107
file: (comment | split_line)+
108108
comment : '#' string*\n
109-
split_line : feature_flag_name ' ' treatment\n
110-
feature_flag_name : string
109+
split_line : feature_name ' ' treatment\n
110+
feature_name : string
111111
treatment : string
112112

113113
This is an example of a ``.split`` file: ::
114114

115115
# This is a comment
116-
feature_flag_0 treatment_0
117-
feature_flag_1 treatment_1
116+
feature_0 treatment_0
117+
feature_1 treatment_1
118118

119-
Whenever a treatment is requested for the feature flag ``feature_flag_0``, ``treatment_0`` is going to be returned. The same goes for ``feature_flag_1`` and ``treatment_1``. The following example illustrates the behaviour: ::
119+
Whenever a treatment is requested for the feature ``feature_0``, ``treatment_0`` is going to be returned. The same goes for ``feature_1`` and ``treatment_1``. The following example illustrates the behaviour: ::
120120

121121
>>> from splitio import get_factory
122122
>>> factory = get_factory('localhost')
123123
>>> client = factory.client()
124-
>>> client.get_treatment('some_user', 'feature_flag_0')
124+
>>> client.get_treatment('some_user', 'feature_0')
125125
'treatment_0'
126-
>>> client.get_treatment('some_other_user', 'feature_flag_0')
126+
>>> client.get_treatment('some_other_user', 'feature_0')
127127
'treatment_0'
128-
>>> client.get_treatment('yet_another_user', 'feature_flag_1')
128+
>>> client.get_treatment('yet_another_user', 'feature_1')
129129
'treatment_1'
130-
>>> client.get_treatment('some_user', 'non_existent_feature_flag')
130+
>>> client.get_treatment('some_user', 'non_existent_feature')
131131
'CONTROL'
132132

133-
Notice that an API key is not necessary for the localhost environment, and the ``CONTROL`` is returned for non existent feature flags.
133+
Notice that an API key is not necessary for the localhost environment, and the ``CONTROL`` is returned for non existent features.
134134

135135
It is possible to specify a different splits file using the ``split_definition_file_name`` argument: ::
136136

@@ -161,7 +161,7 @@ Before you can use it, you need to install the ``splitio_client`` with support f
161161

162162
pip install splitio_client[redis]
163163

164-
The client depends on the information for feature flags and segments being updated externally. In order to do that, we provide the ``update_splits`` and ``update_segments`` scripts or even the ``splitio.bin.synchronizer`` service.
164+
The client depends on the information for features and segments being updated externally. In order to do that, we provide the ``update_splits`` and ``update_segments`` scripts or even the ``splitio.bin.synchronizer`` service.
165165

166166
The scripts are configured through a JSON settings file, like the following: ::
167167

@@ -198,7 +198,7 @@ These are the possible configuration parameters:
198198
| redisDb | int | The db number on the Redis instance | 0 |
199199
+------------------------+------+--------------------------------------------------------+-------------------------------+
200200

201-
Let's assume that the configuration file is called ``splitio-config.json`` and that the client is installed in a virtualenv in ``/home/user/venv``. The feature flag update script can be run with: ::
201+
Let's assume that the configuration file is called ``splitio-config.json`` and that the client is installed in a virtualenv in ``/home/user/venv``. The feature update script can be run with: ::
202202

203203
$ /home/user/venv/bin/python -m splitio.update_scripts.update_splits splitio-config.json
204204

0 commit comments

Comments
 (0)