Bug 167102 - Web Inspector: Dashboard's log/error/warning help tag says "click to show the Console" even when clicking does nothing
Summary: Web Inspector: Dashboard's log/error/warning help tag says "click to show the...
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Web Inspector (show other bugs)
Version: WebKit Nightly Build
Hardware: All All
: P2 Normal
Assignee: Devin Rousso
URL:
Keywords: InRadar
Depends on:
Blocks:
 
Reported: 2017-01-16 15:57 PST by BJ Burg
Modified: 2017-01-19 10:00 PST (History)
5 users (show)

See Also:


Attachments
Patch (8.28 KB, patch)
2017-01-16 16:24 PST, Devin Rousso
no flags Details | Formatted Diff | Diff
Patch (9.64 KB, patch)
2017-01-16 21:24 PST, Devin Rousso
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description BJ Burg 2017-01-16 15:57:25 PST
<rdar://problem/14078306>
Comment 1 BJ Burg 2017-01-16 16:01:37 PST
Note that the help tags also have improper text. It should only describe what clicking on the button does. A more detailed explanation of what the icons and numbers means should belong in a help document.

"Show page resources"
"Show resource load information"
"Show resource load information"
"Show messages logged to the Console"
"Show warnings logged to the Console"
"Show errors logged to the Console"
Comment 2 Devin Rousso 2017-01-16 16:24:30 PST
Created attachment 298999 [details]
Patch

So this patch addresses the tooltips, but I'm not sure what to about "clicking does nothing".  Should we dim the icon, or are you just suggesting that we change the tooltip when the related view is shown?
Comment 3 Timothy Hatcher 2017-01-16 18:51:06 PST
Comment on attachment 298999 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=298999&action=review

> Source/WebInspectorUI/UserInterface/Views/DefaultDashboardView.js:57
> -                tooltip: WebInspector.UIString("Total number of resources, click to show the Resources tab"),
> +                tooltip: WebInspector.UIString("Show page resources"),
>                  handler: this._resourcesItemWasClicked
>              },
>              resourcesSize: {
> -                tooltip: WebInspector.UIString("Total size of all resources, click to show the Network Requests timeline"),
> +                tooltip: WebInspector.UIString("Show network information"),
>                  handler: this._networkItemWasClicked
>              },
>              time: {
> -                tooltip: WebInspector.UIString("Time until the load event fired, click to show the Network Requests timeline"),
> +                tooltip: WebInspector.UIString("Show page load timing"),
>                  handler: this._timelineItemWasClicked
>              },
>              logs: {
> -                tooltip: WebInspector.UIString("Console logs, click to show the Console tab"),
> +                tooltip: WebInspector.UIString("Show messages logged to the Console"),
>                  handler: this._consoleItemWasClicked.bind(this, WebInspector.LogContentView.Scopes.Logs)
>              },
>              errors: {
> -                tooltip: WebInspector.UIString("Console errors, click to show the Console tab"),
> +                tooltip: WebInspector.UIString("Show errors logged to the Console"),
>                  handler: this._consoleItemWasClicked.bind(this, WebInspector.LogContentView.Scopes.Errors)
>              },
>              issues: {
> -                tooltip: WebInspector.UIString("Console warnings, click to show the Console tab"),
> +                tooltip: WebInspector.UIString("Show warnings logged to the Console"),

I think the old tooltips are still useful. They describe the number and what happens when clicked.
Comment 4 BJ Burg 2017-01-16 20:18:42 PST
(In reply to comment #3)
> Comment on attachment 298999 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=298999&action=review
> 
> > Source/WebInspectorUI/UserInterface/Views/DefaultDashboardView.js:57
> > -                tooltip: WebInspector.UIString("Total number of resources, click to show the Resources tab"),
> > +                tooltip: WebInspector.UIString("Show page resources"),
> >                  handler: this._resourcesItemWasClicked
> >              },
> >              resourcesSize: {
> > -                tooltip: WebInspector.UIString("Total size of all resources, click to show the Network Requests timeline"),
> > +                tooltip: WebInspector.UIString("Show network information"),
> >                  handler: this._networkItemWasClicked
> >              },
> >              time: {
> > -                tooltip: WebInspector.UIString("Time until the load event fired, click to show the Network Requests timeline"),
> > +                tooltip: WebInspector.UIString("Show page load timing"),
> >                  handler: this._timelineItemWasClicked
> >              },
> >              logs: {
> > -                tooltip: WebInspector.UIString("Console logs, click to show the Console tab"),
> > +                tooltip: WebInspector.UIString("Show messages logged to the Console"),
> >                  handler: this._consoleItemWasClicked.bind(this, WebInspector.LogContentView.Scopes.Logs)
> >              },
> >              errors: {
> > -                tooltip: WebInspector.UIString("Console errors, click to show the Console tab"),
> > +                tooltip: WebInspector.UIString("Show errors logged to the Console"),
> >                  handler: this._consoleItemWasClicked.bind(this, WebInspector.LogContentView.Scopes.Errors)
> >              },
> >              issues: {
> > -                tooltip: WebInspector.UIString("Console warnings, click to show the Console tab"),
> > +                tooltip: WebInspector.UIString("Show warnings logged to the Console"),
> 
> I think the old tooltips are still useful. They describe the number and what
> happens when clicked.

The existing text is grammatically confusing and we have reports from users and localizers to that effect. It is also inconsistent with macOS HIG; it shouldn't say "click", "press" etc., just "show" or "build" or "run" or whatever it does.

If we want to label the number and the button, why can't they have different tooltips? Or, text such as "Show warnings logged to the console (14 warnings)". FWIW, Xcode doesn't have any tooltips at all for dashboard warnings/errors.

To Devin's question, this bug is originally about the tooltip describing an action that doesn't occur when you click on the thing the tooltip describes. We could show no tooltip, have the same text and hope users realize it's grayed out, or have text to the effect of "There are no console errors"
Comment 5 Devin Rousso 2017-01-16 21:24:06 PST
Created attachment 299019 [details]
Patch
Comment 6 BJ Burg 2017-01-17 16:54:11 PST
Comment on attachment 299019 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=299019&action=review

r=me

> Source/WebInspectorUI/ChangeLog:10
> +        Don't revert to the All scopes if the requested scope is already selected.

I am in favor of this change, just for consistency. Please wait a day to land this, in case someone wants to discuss it.
Comment 7 WebKit Commit Bot 2017-01-19 10:00:24 PST
Comment on attachment 299019 [details]
Patch

Clearing flags on attachment: 299019

Committed r210928: <http://trac.webkit.org/changeset/210928>
Comment 8 WebKit Commit Bot 2017-01-19 10:00:28 PST
All reviewed patches have been landed.  Closing bug.