jenkins-bot has submitted this change and it was merged.
Change subject: Improve documentation of getEventLogSamplingID method in
WikipediaApp
......................................................................
Improve documentation of getEventLogSamplingID method in WikipediaApp
This patch improves the documentation of the getEventLogSamplingID method in
WikipediaApp, to make it clearer what it can and cannot be used for. This
should remove some ambiguity for any new contributors to the code base.
Change-Id: I03ba747cb123a6881b148c565bfbb487dd867662
---
M app/src/main/java/org/wikipedia/WikipediaApp.java
1 file changed, 8 insertions(+), 2 deletions(-)
Approvals:
Dbrant: Looks good to me, approved
Niedzielski: Looks good to me, but someone else must approve
jenkins-bot: Verified
diff --git a/app/src/main/java/org/wikipedia/WikipediaApp.java
b/app/src/main/java/org/wikipedia/WikipediaApp.java
index 6373d35..6a5711e 100644
--- a/app/src/main/java/org/wikipedia/WikipediaApp.java
+++ b/app/src/main/java/org/wikipedia/WikipediaApp.java
@@ -378,8 +378,14 @@
}
/**
- * Get an integer-valued random ID for event log sampling. This value will
persist for the
- * lifetime of the app.
+ * Get an integer-valued random ID. This is typically used to determine
global EventLogging
+ * sampling, that is, whether the user's instance of the app sends any
events or not. This is a
+ * pure technical measure which is necessary to prevent overloading
EventLogging with too many
+ * events. This value will persist for the lifetime of the app.
+ *
+ * Don't use this method when running to determine whether or not the user
falls into a control
+ * or test group in any kind of tests (such as A/B tests), as that would
introduce sampling
+ * biases which would invalidate the test.
* @return Integer ID for event log sampling.
*/
@IntRange(from = 0)
--
To view, visit https://gerrit.wikimedia.org/r/265784
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I03ba747cb123a6881b148c565bfbb487dd867662
Gerrit-PatchSet: 2
Gerrit-Project: apps/android/wikipedia
Gerrit-Branch: master
Gerrit-Owner: Deskana <[email protected]>
Gerrit-Reviewer: BearND <[email protected]>
Gerrit-Reviewer: Brion VIBBER <[email protected]>
Gerrit-Reviewer: Dbrant <[email protected]>
Gerrit-Reviewer: Mholloway <[email protected]>
Gerrit-Reviewer: Niedzielski <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
