Skip to content

Commit 40ef808

Browse files
zinkkrystyandrew
authored andcommitted
Document the option reset_manually (#534)
Introduced in #430
1 parent 61cb4e9 commit 40ef808

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,12 @@ The user will then always see the alternative they started with.
210210

211211
Any old unfinished experiment key will be deleted from the user's data storage if the experiment had been removed or is over and a winner had been chosen. This allows a user to enroll into any new experiment in cases when the `allow_multiple_experiments` config option is set to `false`.
212212

213+
### Reset experiments manually
214+
215+
By default Split automatically resets the experiment whenever it detects the configuration for an experiment has changed (e.g. you call `ab_test` with different alternatives). You can prevent this by setting the option `reset_manually` to `true`.
216+
217+
You may want to do this when you want to change something, like the variants' names, the metadata about an experiment, etc. without resetting everything.
218+
213219
### Multiple experiments at once
214220

215221
By default Split will avoid users participating in multiple experiments at once. This means you are less likely to skew results by adding in more variation to your tests.
@@ -450,6 +456,7 @@ Split.configure do |config|
450456
config.enabled = true
451457
config.persistence = Split::Persistence::SessionAdapter
452458
#config.start_manually = false ## new test will have to be started manually from the admin panel. default false
459+
#config.reset_manually = false ## if true, it never resets the experiment data, even if the configuration changes
453460
config.include_rails_helper = true
454461
config.redis = "redis://custom.redis.url:6380"
455462
end

0 commit comments

Comments
 (0)