From 0093a5db2c11a5502309fe383c391e4cac7e555c Mon Sep 17 00:00:00 2001 From: Alessio Placitelli Date: Wed, 5 May 2021 12:15:09 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Jan-Erik Rediger --- docs/user/reference/general/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/user/reference/general/index.md b/docs/user/reference/general/index.md index 568463229..e6f481966 100644 --- a/docs/user/reference/general/index.md +++ b/docs/user/reference/general/index.md @@ -40,10 +40,11 @@ The following steps are required for applications using the Glean SDK, but not l {{#include ../../shared/blockquote-stop.html}} -##### Do not initialize with a fake value for `uploadEnabled`! +##### Initialize clean with the correct value for `uploadEnabled`! -> `Glean.initialize` **must** always be called with real values. -> For example, never call `Glean.initialize(upload=true)` if `true` is a placeholder value that later gets reset by `Glean.setUploadEnabled(false)`. +> `Glean.initialize` must **always** be called with real values. +> Always pass the user preferencen, e.g. `Glean.initialize(upload=userSettings.telemetry_enabled)` or the equivalent for your application. +> Never call `Glean.initialize(upload=true)` if `true` is a placeholder value that later gets reset by `Glean.setUploadEnabled(false)`. > Depending on the provided placeholder value, this might trigger the generation of new client ids or the submission of bogus [`deletion-request` pings](../user/pings/deletion_request.md). {{#include ../../../shared/tab_header.md}}