Leakcanary: Better explanation on "App visible, waiting until <n> retained objects" in notification

[orionlee]

Version: 2.0.0-beta3

Suggestions:
During running LeakCanary against an app, I occasionally see the following notification.
1 retained objects, tap to dump heap
App visible, waiting until retained objects

When I exit the app, a new notification suggesting the retained object is garbage collected.

From what I gather, it seems to mean LeakCanary find objects that might or might not be leaking (and decides to wait for further information). It'd be better if it's explained somewhere (in website or in app).

Thanks.

[MetalDent]

Hi, is anyone working on this issue?

[Armaxis]

Watching and retaining is mostly covered in the Fundamentals:
https://square.github.io/leakcanary/fundamentals/

However, we can probably add a section about notifications.

[MetalDent]

@Armaxis where do you think the section on notifications should go?

[Armaxis]

I think 'Code Recipes' is a good starting place, we can always move it later.

[MetalDent]

And can you tell me the rough explanation to be written? (I just need it for reference)

[Armaxis]

Just something explaining different types of notifications user can see during work: about retained instances, heap dump notification, leak analysis and results availability.

[pyricau]

Agreed, we need to better document this.

Also not sure if there's a way to make the notifications more clear.