Skip to content
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

add 'description' for object setting #1045

Merged
merged 1 commit into from Feb 21, 2019

Conversation

Projects
None yet
2 participants
@olsonpm
Copy link

olsonpm commented Feb 12, 2018

Description of the Change

This PR adds a description to configurations of type 'object'.

Currently a 'description' for a configuration of type 'object' is ignored. This is problematic because objects allow for a grouping or subset of options which may need a description applying to all of them. Without the object description field, settings under a scope are forced to repeatedly describe something.

Alternate Designs

No alternate designs were considered. I figured this was a straight forward change and I honestly have no clue what an alternate solution could even be.

Benefits

  • Removes the need to repeat descriptions for object properties such as these
    Note: the above link contains a repetitive note inside each scoped config description

Possible Drawbacks

  • Due to poor nested object UI, a description for a nested property of type 'object' will not visually be understood as applying to its scoped configurations.

Applicable Issues

fixes #857

@lee-dohm lee-dohm merged commit cbdab0e into atom:master Feb 21, 2019

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.