Merge pull request #10552 from dirk-thomas/patch-1

improve docs about grouped settings
This commit is contained in:
Lee Dohm
2016-02-03 16:44:45 -08:00

View File

@@ -203,22 +203,6 @@ ScopeDescriptor = require './scope-descriptor'
# maximum: 11.5
# ```
#
# #### object
#
# Value must be an object. This allows you to nest config options. Sub options
# must be under a `properties key`
#
# ```coffee
# config:
# someSetting:
# type: 'object'
# properties:
# myChildIntOption:
# type: 'integer'
# minimum: 1.5
# maximum: 11.5
# ```
#
# #### color
#
# Values will be coerced into a {Color} with `red`, `green`, `blue`, and `alpha`
@@ -234,6 +218,23 @@ ScopeDescriptor = require './scope-descriptor'
# default: 'white'
# ```
#
# ### Grouping
#
# A config setting with the type `object` allows grouping a set of config
# settings. The group will be visualy separated and has its own group headline.
# The sub options must be listed under a `properties` key.
#
# ```coffee
# config:
# someSetting:
# type: 'object'
# properties:
# myChildIntOption:
# type: 'integer'
# minimum: 1.5
# maximum: 11.5
# ```
#
# ### Other Supported Keys
#
# #### enum
@@ -292,6 +293,9 @@ ScopeDescriptor = require './scope-descriptor'
#
# Descriptions will be displayed below the title in the settings view.
#
# For a group of config settings the humanized key or the title and the
# description are used for the group headline.
#
# ```coffee
# config:
# someSetting: