From 33d4ace8e9bda6d3328951aa9eae6ceeeb758a01 Mon Sep 17 00:00:00 2001 From: Ben Ogle Date: Thu, 25 Sep 2014 12:52:56 -0700 Subject: [PATCH] :memo: more docs for Config --- src/config.coffee | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/config.coffee b/src/config.coffee index cdee9f68d..e1188e24f 100644 --- a/src/config.coffee +++ b/src/config.coffee @@ -113,6 +113,23 @@ pathWatcher = require 'pathwatcher' # # ### Supported Types # +# The `type` keyword can be a string with any one of the following. You can also +# chain them by specifying multiple in an an array. For example +# +# ```coffee +# config: +# someSetting: +# type: ['boolean', 'integer'] +# default: 5 +# +# # Then +# atom.config.set('my-package.someSetting', 'true') +# atom.config.get('my-package.someSetting') # -> true +# +# atom.config.set('my-package.someSetting', '12') +# atom.config.get('my-package.someSetting') # -> 12 +# ``` +# # #### string # # Values must be a string.