New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show enum description as default in tooltip #1066

Merged
merged 1 commit into from Sep 6, 2018

Conversation

Projects
None yet
3 participants
@sonicdoe
Contributor

sonicdoe commented Jul 10, 2018

Description of the Change

The default value of a configuration setting is shown next to it in a tooltip. Configuration settings also support an enum key with description properties which will be displayed instead of the raw values. This description, however, only applies to the drop-down itself but not the tooltip. For example:

Screenshot showing the tooltip with “Default: default”

Since the value and description properties may not be similar, one can’t be sure which value is actually the default one. The “Color Profile” setting above is actually a good example: What’s default?

This pull request changes the tooltip to show the description instead (so it matches the drop-down’s choices):

Screenshot showing the tooltip with “Default: Use color profile configured in the operating system”

Alternate Designs

The default value could also be marked in the drop-down itself, for example by suffixing “(default)”. The proposed version was selected because it fits with the existing style of indicating default values.

Benefits

It will be more obvious which value is the default value, especially in cases where the raw value (value) and the description (description) aren’t similar.

Possible Drawbacks

  • It will no longer be possible to view the raw value of such a configuration setting.
  • Tooltips may become quite large since descriptions are usually longer than their raw values.
@lee-dohm

This comment has been minimized.

Show comment
Hide comment
@lee-dohm

lee-dohm Jul 10, 2018

Member

@daviwil Can you do the needful here?

@sonicdoe Thanks very much for the contribution!

Member

lee-dohm commented Jul 10, 2018

@daviwil Can you do the needful here?

@sonicdoe Thanks very much for the contribution!

@daviwil daviwil merged commit 033ff00 into atom:master Sep 6, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@sonicdoe sonicdoe deleted the sonicdoe:default-tooltip-enum branch Sep 14, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment