Skip to content

Commit

Permalink
Bug 1862641 - Reword note about calling with the correct uploadEnable…
Browse files Browse the repository at this point in the history
…d value

[doc only]
  • Loading branch information
badboy committed Nov 14, 2023
1 parent 0050d4c commit 8418ad1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/user/reference/general/initializing.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ To learn about SDK specific configuration options available, refer to the [Refer
> Glean must **always** be initialized with real values.
>
> Always pass the user preference, e.g. `Glean.initialize(uploadEnabled=userSettings.telemetryEnabled)` or the equivalent for your application.
> Never call `Glean.initialize(uploadEnabled=true)` if `true` is a placeholder value that later gets reset by `Glean.setUploadEnabled(false)` and vice-versa.
>
> 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).
> Calling `Glean.setUploadEnabled(false)` at a later point will trigger [`deletion-request` pings](../../user/pings/deletion-request.md) and regenerate client IDs.
> This should only be done if the user preference actually changes.
{{#include ../../../shared/tab_header.md}}

Expand Down

0 comments on commit 8418ad1

Please sign in to comment.