Clarify when Glean.initialize must be called

mozilla · Oct 19, 2020 · a1bc8e2 · a1bc8e2
1 parent 4a55509
commit a1bc8e2
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/user/general-api.md b/docs/user/general-api.md
@@ -31,6 +31,8 @@ The following steps are required for applications using the Glean SDK, but not l
 > does this as part of its initialization, it is _required_ to always call the `initialize`
 > function. Otherwise, Glean won't be able to clean up collected data, disable queuing of pre-init
 > tasks, or perform other required operations.
+>
+> This does not apply to special builds where telemetry is disabled at build time. In that case, it is acceptable to not call `initialize` at all.
 
 {{#include ../tab_header.md}}