[ABExperiment] Rename parameter and add doc

GitOrigin-RevId: d332803ebdbdcc073df661b1adebb64c1af42ff9
This commit is contained in:
Dmitry Pogrebnoy
2024-05-13 21:15:53 +00:00
committed by intellij-monorepo-bot
parent abe973919d
commit 129419aa70
2 changed files with 6 additions and 2 deletions
@@ -22,9 +22,13 @@ interface ABExperimentOption {
* In such a case, you need to communicate with related persons of other options
* to handle such a case and rearrange option groups accordingly.
*
* @param isPopularIde true if the current IDE is popular.
* It can be used to adjust the group size of the option accordingly.
* Popular IDEs have more users and the group size should be smaller than it is in other IDEs.
*
* @see com.intellij.platform.experiment.ab.impl.experiment.ABExperiment.TOTAL_NUMBER_OF_GROUPS
*/
fun getGroupSizeForIde(isPopular: Boolean): ABExperimentOptionGroupSize
fun getGroupSizeForIde(isPopularIde: Boolean): ABExperimentOptionGroupSize
/**
* Check if the option should be enabled in a certain IDE.
@@ -14,7 +14,7 @@ internal class ABExperimentControlOption : ABExperimentOption {
override val id: ABExperimentOptionId = ABExperimentOptionId("control.option")
override fun getGroupSizeForIde(isPopular: Boolean): ABExperimentOptionGroupSize {
override fun getGroupSizeForIde(isPopularIde: Boolean): ABExperimentOptionGroupSize {
return ABExperimentOptionGroupSize(32)
}