github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-22 13:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

Doc 💄

Browse Source
This commit is contained in:
Ben Ogle
2014-09-25 17:42:41 -07:00
parent 04d045227a
commit 804d0d9911
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/config.coffee
View File

@@ -12,10 +12,10 @@ pathWatcher = require 'pathwatcher'
#
# An instance of this class is always available as the `atom.config` global.
#
# ## Getting and setting config settings
# ## Getting and setting config settings. Note that with no value set, {::get}
# returns the setting's default value.
#
# ```coffee
# # With no value set, `::get` returns the setting's default value
# atom.config.get('my-package.myKey') # -> 'defaultValue'
#
# atom.config.set('my-package.myKey', 'value')
@@ -244,7 +244,7 @@ pathWatcher = require 'pathwatcher'
#
# #### title and description
#
# The settings view will use the `title` and `description` keys display your
# The settings view will use the `title` and `description` keys to display your
# config setting in a readable way. By default the settings view humanizes your
# config key, so `someSetting` becomes `Some Setting`. In some cases, this is
# confusing for users, and a more descriptive title is useful.
@@ -260,7 +260,7 @@ pathWatcher = require 'pathwatcher'
# default: 4
# ```
#
# __Note__: You should strive to be so clear in your naming of the setting that
# __Note__: You should strive to be so clear in your naming of the setting that
# you do not need to specify a title or description!
#
# ## Best practices