1634754 - `on_ready_to_submit_pings` doesn't say when it should be called

Status: RESOLVED INVALID

(Data Platform and Tools :: Glean: SDK, task, P4)

Description

[Chris H-C :chutten]

Well, I mean it provides hints to the earliest time it is usually called ( "after all of the core metrics have been set and the ping types have been registered"), but what if I don't call it at all? What does that prevent me from doing?

Maybe the docs should be rewritten to include a note about what this should be called before... and maybe it could include a thumbnail about what the function is doing instead of just being about when it should be called.

Comment 1

[Alessio Placitelli [:Dexter]]

Chris, do you mean this?

Please note that this is not for API consumers to call. In FOG you're calling it because the "glean-api" rust crate is not there. In general, that would be hidden behind a Glean.initialize function.

Or did you mean something else?

Comment 2

[Chris H-C :chutten]

I do mean that. And as someone who might be tasked with fixing bugs within the "glean-api" or "glean_sdk" crate in future, I'd still like some clarification in the comments : )

Comment 3

[Jan-Erik Rediger [:janerik]]

on_ready_to_submit_pings is not part of the public API anymore. It's called internally. And since this bug was filed the docs were even updated to be more precise.