From 0bc1407e7d91d490eb0d3764315c324e9e0ef9c8 Mon Sep 17 00:00:00 2001 From: Ben Ogle Date: Wed, 15 Oct 2014 18:16:44 -0700 Subject: [PATCH] :memo: Add doc strings --- src/config.coffee | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/config.coffee b/src/config.coffee index b221382bc..0a7384bfd 100644 --- a/src/config.coffee +++ b/src/config.coffee @@ -538,6 +538,7 @@ class Config # cases calling this is not necessary! {::get} returns the default value when # a custom value is not specified. # + # * `scopeSelector` (optional) {String}. eg. '.source.ruby' # * `keyPath` The {String} name of the key. # # Returns the default value. @@ -555,6 +556,7 @@ class Config # Extended: Is the value at `keyPath` its default value? # + # * `scopeSelector` (optional) {String}. eg. '.source.ruby' # * `keyPath` The {String} name of the key. # # Returns a {Boolean}, `true` if the current value is the default, `false` @@ -587,7 +589,9 @@ class Config schema # Extended: Returns a new {Object} containing all of the global settings and - # defaults. This does not include scoped settings. + # defaults. Returns the scoped settings when a `scopeSelector` is specified. + # + # * `scopeSelector` (optional) {String}. eg. '.source.ruby' getSettings: (scopeSelector) -> settings = _.deepExtend(@settings, @defaultSettings)