After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 787154 - main-window: Add explanatory tooltips to buttons
main-window: Add explanatory tooltips to buttons
Status: RESOLVED FIXED
Product: polari
Classification: Applications
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: Polari maintainers
Polari maintainers
Depends on:
Blocks:
 
 
Reported: 2017-09-01 19:01 UTC by Daniel Boles
Modified: 2017-10-28 19:33 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
main-window: Add explanatory tooltips to buttons (1.40 KB, patch)
2017-09-01 19:01 UTC, Daniel Boles
none Details | Review
main-window: Add tooltip to Join button (994 bytes, patch)
2017-09-02 11:50 UTC, Daniel Boles
committed Details | Review
main-window: Add accessible/tooltip to user button (1.42 KB, patch)
2017-09-02 11:51 UTC, Daniel Boles
none Details | Review
main-window: Add tooltip to user list button (977 bytes, patch)
2017-09-12 21:45 UTC, Daniel Boles
committed Details | Review

Description Daniel Boles 2017-09-01 19:01:26 UTC
These are nice to have for anyone, and might be essential for a11y.
Comment 1 Daniel Boles 2017-09-01 19:01:30 UTC
Created attachment 358959 [details] [review]
main-window: Add explanatory tooltips to buttons
Comment 2 Florian Müllner 2017-09-01 19:32:34 UTC
(In reply to Daniel Boles from comment #0)
> [...] might be essential for a11y.

No, it's not essential (or relevant) for a11y, as both buttons already have an accessible name.

As I understand, tooltips are discouraged nowadays, but I don't particular mind them if Bastian agrees. I do think the join-button's accessible name is better than the proposed tooltip though (pus re-using the existing string means there's no string break involved)
Comment 3 Daniel Boles 2017-09-02 11:43:53 UTC
(In reply to Florian Müllner from comment #2)
> No, it's not essential (or relevant) for a11y, as both buttons already have
> an accessible name.

Indeed, thanks.


> As I understand, tooltips are discouraged nowadays

Really? I hope not. If so, that's bizarre to me.

I don't need them for a11y, but I do like to have discoverability and to avoid surprises. So, I prefer programs that - if they insist on using images for buttons and whatnot - at least give me a way to figure out what that button's going to do without clicking on it, potentially fatally (yes, I know about ".destructive-action", but still). Not all icons can be 100% obvious all the time, and we have some that are almost completely inscrutable.


> do think the join-button's accessible name is
> better than the proposed tooltip though (pus re-using the existing string
> means there's no string break involved)

Sure, that makes sense.

What about the user list button? It has no AtkObject, first and foremost.

Secondarily, would you prefer a longer, sentence-case description than my earlier "User List" in either the a11y or tooltip cases?
Comment 4 Daniel Boles 2017-09-02 11:50:55 UTC
Created attachment 358978 [details] [review]
main-window: Add tooltip to Join button

Use the same string as the accessible name, to aid translators.
Comment 5 Daniel Boles 2017-09-02 11:51:07 UTC
Created attachment 358979 [details] [review]
main-window: Add accessible/tooltip to user button

It was lacking both.
Comment 6 Florian Müllner 2017-09-02 12:32:43 UTC
Review of attachment 358979 [details] [review]:

There is no point in setting an accessible name in the .ui file that is always overridden from code (see userList.js)
Comment 7 Daniel Boles 2017-09-05 14:34:03 UTC
Thanks for the correction. I couldn't see where that was done... another hint would be appreciated!

How about Attachment 358978 [details]?
Comment 8 Florian Müllner 2017-09-05 15:03:55 UTC
(In reply to Daniel Boles from comment #7)
> Thanks for the correction. I couldn't see where that was done... another
> hint would be appreciated!

Ah yes, sorry - not userList.js but here:
https://git.gnome.org/browse/polari/tree/src/mainWindow.js#n375


> How about Attachment 358978 [details]?

If Bastian is fine with adding tooltips, then the patch looks good to me. It doesn't break the string freeze, so it would be possible to push it after 3.26.0 is released, however I don't like the idea of adding one tooltip in 3.26 and the other one in 3.28. I don't think there's a string we can reuse for the user-list button, so that tooltip will need a string freeze break if we want it in 3.26 ...
Comment 9 Daniel Boles 2017-09-05 15:09:31 UTC
(In reply to Florian Müllner from comment #8)
> Ah yes, sorry - not userList.js but here:
> https://git.gnome.org/browse/polari/tree/src/mainWindow.js#n375

Great, thanks!


> I don't think there's a string we can reuse
> for the user-list button, so that tooltip will need a string freeze break if
> we want it in 3.26 ...

I'm not in a rush if you're not! It'd just be nice to get them in at some point.


> > How about Attachment 358978 [details]?
> 
> If Bastian is fine with adding tooltips, then the patch looks good to me. It
> doesn't break the string freeze, so it would be possible to push it after
> 3.26.0 is released, however I don't like the idea of adding one tooltip in
> 3.26 and the other one in 3.28.

Sure, it makes more sense to keep them together, whenever they end up landing.
Comment 10 Daniel Boles 2017-09-12 21:45:24 UTC
Created attachment 359671 [details] [review]
main-window: Add tooltip to user list button

--

I thought of a few different strings, but this seemed like a good combination of
concise vs descriptive. Of course, someone else probably has a better one!
Comment 11 Florian Müllner 2017-10-28 19:31:41 UTC
Review of attachment 359671 [details] [review]:

"Show info" sounds a bit too colloquial IMHO, I'll go with "Show connected users" instead ...
Comment 12 Florian Müllner 2017-10-28 19:32:54 UTC
Attachment 358978 [details] pushed as 9dfa989 - main-window: Add tooltip to Join button
Attachment 359671 [details] pushed as b9d2f7a - main-window: Add tooltip to user list button