aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhil Crosby2014-04-30 00:54:50 -0700
committerPhil Crosby2014-04-30 00:54:50 -0700
commitc79b35114270ada790a564e1794d042dadf07356 (patch)
tree3d0f7fa03932829f54444823d5a32b905187c2ae
parent2b440edd7e27e4e6595fbf235a83883ad9af2539 (diff)
downloadvimium-c79b35114270ada790a564e1794d042dadf07356.tar.bz2
Tweak a few comments
-rw-r--r--background_scripts/settings.coffee16
-rw-r--r--background_scripts/sync.coffee12
2 files changed, 13 insertions, 15 deletions
diff --git a/background_scripts/settings.coffee b/background_scripts/settings.coffee
index 73a7a04b..c26da5a4 100644
--- a/background_scripts/settings.coffee
+++ b/background_scripts/settings.coffee
@@ -1,5 +1,5 @@
#
-# Used by everyone to manipulate localStorage.
+# Used by all parts of Vimium to manipulate localStorage.
#
root = exports ? window
@@ -8,7 +8,7 @@ root.Settings = Settings =
if (key of localStorage) then JSON.parse(localStorage[key]) else @defaults[key]
set: (key, value) ->
- # don't store the value if it is equal to the default, so we can change the defaults in the future
+ # Don't store the value if it is equal to the default, so we can change the defaults in the future
if (value == @defaults[key])
@clear(key)
else
@@ -23,9 +23,9 @@ root.Settings = Settings =
has: (key) -> key of localStorage
- # for settings which require action when their value changes, add hooks here
- # called from options/options.coffee (when the options page is saved), and from background_scripts/sync.coffee (when
- # an update propagates from chrome.storage.sync).
+ # For settings which require action when their value changes, add hooks here called from
+ # options/options.coffee (when the options page is saved), and from background_scripts/sync.coffee (when an
+ # update propagates from chrome.storage.sync).
postUpdateHooks:
keyMappings: (value) ->
root.Commands.clearKeyMappingsAndSetDefaults()
@@ -36,8 +36,8 @@ root.Settings = Settings =
performPostUpdateHook: (key, value) ->
@postUpdateHooks[key] value if @postUpdateHooks[key]
- # options/options.(coffee|html) only handle booleans and strings; therefore
- # all defaults must be booleans or strings
+ # options.coffee and options.html only handle booleans and strings; therefore all defaults must be booleans
+ # or strings
defaults:
scrollStepSize: 60
linkHintCharacters: "sadfjklewcmpgh"
@@ -67,7 +67,7 @@ root.Settings = Settings =
"""
http*://mail.google.com/*
"""
- # NOTE : If a page contains both a single angle-bracket link and a double angle-bracket link, then in
+ # NOTE: If a page contains both a single angle-bracket link and a double angle-bracket link, then in
# most cases the single bracket link will be "prev/next page" and the double bracket link will be
# "first/last page", so we put the single bracket first in the pattern string so that it gets searched
# for first.
diff --git a/background_scripts/sync.coffee b/background_scripts/sync.coffee
index f1c5c0cc..93430856 100644
--- a/background_scripts/sync.coffee
+++ b/background_scripts/sync.coffee
@@ -20,15 +20,13 @@
root = exports ? window
root.Sync = Sync =
- # 19/4/14:
- # Leave logging statements in, but disable debugging.
- # We may need to come back to this, so removing logging now would be premature.
- # However, if users have problems, they are unlikely to notice and make sense of console logs on
- # background pages. So disable it, by default.
- # For genuine errors, we call console.log directly.
+ # April 19 2014: Leave logging statements in, but disable debugging. We may need to come back to this, so
+ # removing logging now would be premature. However, if users report problems, they are unlikely to notice
+ # and make sense of console logs on background pages. So disable it, by default. For genuine errors, we
+ # call console.log directly.
debug: false
storage: chrome.storage.sync
- doNotSync: [ "settingsVersion", "previousVersion" ]
+ doNotSync: ["settingsVersion", "previousVersion"]
# This is called in main.coffee.
init: ->