1242763 - Add tooltips to ALL THE THINGS

Status: RESOLVED FIXED

(DevTools :: Memory, defect, P2)

Description

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Now that we figured out how to make tooltips work in html pages embedded within xul, we should add tooltips to all the things to make usability a bit better.

Comment 1

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Add a bunch of tooltips to the devtools' memory panel

Comment 2

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Part 2: More tooltips for the devtools' memory panel

Comment 3

[Jordan Santell [:jsantell] [@jsantell]]

Comment on attachment 8714431 [details] [diff] [review]
Add a bunch of tooltips to the devtools' memory panel

Review of attachment 8714431 [details] [diff] [review]:
-----------------------------------------------------------------

::: devtools/client/locales/en-US/memory.properties
@@ +53,5 @@
>  checkbox.invertTree=Invert tree
>  
> +# LOCALIZATION NOTE (checkbox.invertTree): The tooltip for the label describing
> +# the boolean checkbox whether or not to invert the tree.
> +checkbox.invertTree.tooltip=When un-inverted, the tree is shown top-down, giving an overview of memory consumption. When inverted, the tree is shown bottom-up, highlighting the heaviest memory consumers. 

nit whitespace

I don't think "un-inverted" should be hyphenated

This is kind of a tautological description -- not sure of a way to describe it that'd handle all scenarios..

@@ +62,5 @@
>  
> +# LOCALIZATION NOTE (checkbox.recordAllocationStacks.tooltip): The tooltip for
> +# the label describing the boolean checkbox whether or not to record allocation
> +# stacks.
> +checkbox.recordAllocationStacks.tooltip=Toggle the recording of allocation stacks. Subsequent heap snapshots will be able to label and group objects by their allocation stack. Recording allocation stacks has a performance overhead.

I'd mention the biggest gotcha here, which is that this only gets allocation sites for objects allocated after enabling

@@ +70,5 @@
>  toolbar.breakdownBy=Group by:
>  
> +# LOCALIZATION NOTE (toolbar.breakdownBy): The tooltip for the label describing
> +# the select menu options of the breakdown options.
> +toolbar.breakdownBy.tooltip=Change the way that objects are grouped

Change how objects are grouped

@@ +78,5 @@
>  toolbar.labelBy=Label by:
>  
> +# LOCALIZATION NOTE (toolbar.labelBy): The tooltip for the label describing the
> +# select menu options of the label options.
> +toolbar.labelBy.tooltip=Change the way that objects are labeled

Change how options are labeled

@@ +278,5 @@
>  heapview.field.retainedSize=Retained Size (Bytes)
>  
> +# LOCALIZATION NOTE (heapview.field.retainedSize.tooltip): The tooltip for the
> +# column header in the dominator tree view for retained byte sizes.
> +heapview.field.retainedSize.tooltip=The size of the object itself, plus the size of all the other objects kept alive by it

s/plus/and

@@ +302,5 @@
>  heapview.field.bytes=Bytes
>  
> +# LOCALIZATION NOTE (heapview.field.bytes.tooltip): The tooltip for the column
> +# header in the heap view for bytes.
> +heapview.field.bytes.tooltip=The number of bytes consumed by things of this group, excluding sub-groups

s/things of //

@@ +310,5 @@
>  heapview.field.count=Count
>  
> +# LOCALIZATION NOTE (heapview.field.count.tooltip): The tooltip for the column
> +# header in the heap view for count.
> +heapview.field.count.tooltip=The number of reachable things of this group, excluding sub-groups

"The number of allocations of this group, excluding sub-groups"

In general, we shouldn't be using the word "things" in this context. Also, I think subgroups should not be hyphenated as well

@@ +318,5 @@
>  heapview.field.totalbytes=Total Bytes
>  
> +# LOCALIZATION NOTE (heapview.field.totalbytes.tooltip): The tooltip for the
> +# column header in the heap view for total bytes.
> +heapview.field.totalbytes.tooltip=The number of bytes consumed by things of this group, including sub-groups

s/things of //

@@ +326,5 @@
>  heapview.field.totalcount=Total Count
>  
> +# LOCALIZATION NOTE (heapview.field.totalcount.tooltip): The tooltip for the
> +# column header in the heap view for total count.
> +heapview.field.totalcount.tooltip=The number of reachable things of this group, including sub-groups

The number of allocations of this group, including subgroups

Comment 4

[Jordan Santell [:jsantell] [@jsantell]]

Comment on attachment 8714502 [details] [diff] [review]
Part 2: More tooltips for the devtools' memory panel

Review of attachment 8714502 [details] [diff] [review]:
-----------------------------------------------------------------

::: devtools/client/locales/en-US/memory.properties
@@ +130,5 @@
>  toolbar.view.dominators=Dominators
>  
> +# LOCALIZATION NOTE (toolbar.view.dominators.tooltip): The tooltip for the label
> +# for the dominators view option in the toolbar.
> +toolbar.view.dominators.tooltip=View the dominator tree and surface the largest objects in the heap snapshot

I'd mention that its not surfacing the largest object necessarily, but objects that are retaining the most objects

::: devtools/client/memory/constants.js
@@ +112,5 @@
>    coarseType: {
>      displayName: "Coarse Type",
> +    get tooltip() {
> +      // Importing down here is necessary because of the circular dependency
> +      // this introduces with `./utils.js`.

ewwwwwwww

Comment 5

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

Attachment: Add a bunch of tooltips to the devtools' memory panel

Comment 6

[Nick Fitzgerald [:fitzgen] [⏰PST; UTC-8]]

New patch is combo of the old two.

Try push: https://treeherder.mozilla.org/#/jobs?repo=try&revision=d19e482a8e52

Comment 7

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/f8344dfd2d25

Comment 8

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/f8344dfd2d25