pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-09-20 15:37:46 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clean up docs

Browse Source
This commit is contained in:
Ben Ogle 2014-10-03 11:57:35 -07:00
parent 47d5b46a1d
commit 4e3c8406ee
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/config.coffee
View File

@ -334,7 +334,9 @@ class Config
# # do stuff with value
# ```
#
# * `scopeDescriptor` (optional) {Array} of {String}s. See {::get} for examples
# * `scopeDescriptor` (optional) {Array} of {String}s describing a path from
# the root of the syntax tree to a token. Get one by calling
# {TextEditor::scopesAtCursor}. See {::get} for examples.
# * `keyPath` {String} name of the key to observe
# * `callback` {Function} to call when the value of the key changes.
# * `value` the new value of the key
@ -368,7 +370,9 @@ class Config
# Essential: Add a listener for changes to a given key path. If `keyPath` is
# not specified, your callback will be called on changes to any key.
#
# * `scopeDescriptor` (optional) {Array} of {String}s. See {::get} for examples
# * `scopeDescriptor` (optional) {Array} of {String}s describing a path from
# the root of the syntax tree to a token. Get one by calling
# {TextEditor::scopesAtCursor}. See {::get} for examples.
# * `keyPath` (optional) {String} name of the key to observe. Must be
# specified if `scopeDescriptor` is specified.
# * `callback` {Function} to call when the value of the key changes.
@ -423,11 +427,13 @@ class Config
# Additionally, you can get the setting at the specific cursor position.
#
# ```coffee
# scopeDescriptor = @editor.scopesForBufferPosition(@editor.getCursorBufferPosition())
# scopeDescriptor = @editor.scopesAtCursor()
# atom.config.get(scopeDescriptor, 'editor.tabLength') # => 2
# ```
#
# * `scopeDescriptor` (optional) {Array} of {String}s.
# * `scopeDescriptor` (optional) {Array} of {String}s describing a path from
# the root of the syntax tree to a token. Get one by calling
# {TextEditor::scopesAtCursor}
# * `keyPath` The {String} name of the key to retrieve.
#
# Returns the value from Atom's default settings, the user's configuration