From 7e71bf356b3df717316427fb3744320afdd6aba2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hrvoje=20=C5=A0imi=C4=87?= <hrvoje@twobucks.co>
Date: Mon, 10 Oct 2016 12:26:47 +0200
Subject: [PATCH] fix various typos and grammar errors in comments (#834)

---
 app/config.js                |  2 +-
 app/index.js                 | 10 +++++-----
 lib/actions/sessions.js      |  2 +-
 lib/actions/ui.js            |  2 +-
 lib/component.js             |  1 +
 lib/components/split-pane.js |  1 +
 lib/hterm.js                 |  4 ++--
 lib/reducers/ui.js           |  9 ++++-----
 lib/utils/effects.js         | 14 ++++++++------
 lib/utils/file.js            | 18 +++++++++++-------
 lib/utils/key-code.js        |  4 ++--
 lib/utils/plugins.js         |  4 ++--
 lib/utils/selection.js       |  2 +-
 13 files changed, 40 insertions(+), 33 deletions(-)

diff --git a/app/config.js b/app/config.js
index f304cbd1..1558aec9 100644
--- a/app/config.js
+++ b/app/config.js
@@ -74,7 +74,7 @@ exports.subscribe = function (fn) {
 
 exports.init = function () {
   // for backwards compatibility with hyperterm
-  // (prior to the renme), we try to rename
+  // (prior to the rename), we try to rename
   // on behalf of the user
   try {
     statSync(pathLegacy);
diff --git a/app/index.js b/app/index.js
index f7b3acac..0046dd99 100644
--- a/app/index.js
+++ b/app/index.js
@@ -34,7 +34,7 @@ app.config = config;
 app.plugins = plugins;
 app.getWindows = () => new Set([...windowSet]); // return a clone
 
-// function to retrive the last focused window in windowSet;
+// function to retrieve the last focused window in windowSet;
 // added to app object in order to expose it to plugins.
 app.getLastFocusedWindow = () => {
   if (!windowSet.size) {
@@ -160,8 +160,8 @@ app.on('ready', () => installDevExtensions(isDev).then(() => {
       }
 
       // app.windowCallback is the createWindow callback
-      // that can be setted before the 'ready' app event
-      // and createWindow deifinition. It's exeuted in place of
+      // that can be set before the 'ready' app event
+      // and createWindow deifinition. It's executed in place of
       // the callback passed as parameter, and deleted right after.
       (app.windowCallback || fn)(win);
       delete (app.windowCallback);
@@ -207,7 +207,7 @@ app.on('ready', () => installDevExtensions(isDev).then(() => {
     });
 
     // TODO: this goes away when we are able to poll
-    // for the title ourseleves, instead of relying
+    // for the title ourselves, instead of relying
     // on Session and focus/blur to subscribe
     rpc.on('focus', ({uid}) => {
       const session = sessions.get(uid);
@@ -400,7 +400,7 @@ app.on('open-file', (event, path) => {
   } else if (!lastWindow && {}.hasOwnProperty.call(app, 'createWindow')) {
     app.createWindow(callback);
   } else {
-    // if createWindow not exists yet ('ready' event was not fired),
+    // If createWindow doesn't exist yet ('ready' event was not fired),
     // sets his callback to an app.windowCallback property.
     app.windowCallback = callback;
   }
diff --git a/lib/actions/sessions.js b/lib/actions/sessions.js
index 9485b1ff..bada1d0f 100644
--- a/lib/actions/sessions.js
+++ b/lib/actions/sessions.js
@@ -167,7 +167,7 @@ export function sendSessionData(uid, data) {
       type: SESSION_USER_DATA,
       data,
       effect() {
-        // If no uid is passed, data is sended to the active session.
+        // If no uid is passed, data is sent to the active session.
         const targetUid = uid || getState().sessions.activeUid;
         rpc.emit('data', {uid: targetUid, data});
       }
diff --git a/lib/actions/ui.js b/lib/actions/ui.js
index 74471e86..84cb627b 100644
--- a/lib/actions/ui.js
+++ b/lib/actions/ui.js
@@ -212,7 +212,7 @@ export function showPreferences() {
           rpc.once('session data', () => {
             dispatch(sendSessionData(
               uid,
-              // Leading space prevents command to be store in shell history
+              // Leading space prevents command to be stored in shell history
               [' echo Attempting to open ~/.hyper.js with your \$EDITOR', // eslint-disable-line no-useless-escape
                ' echo If it fails, open it manually with your favorite editor!',
                ' bash -c \'exec env ${EDITOR:=' + editorFallback + '} ~/.hyper.js\'',
diff --git a/lib/component.js b/lib/component.js
index 013df5e5..3e4b0f43 100644
--- a/lib/component.js
+++ b/lib/component.js
@@ -40,6 +40,7 @@ export default class Component extends React.Component {
         if (c) {
           // we compute the global name from the given
           // css class and we prepend the component name
+          //
           // it's important classes never get mangled by
           // uglifiers so that we can avoid collisions
           const component = this.constructor.name
diff --git a/lib/components/split-pane.js b/lib/components/split-pane.js
index f6fc747e..bce58cf0 100644
--- a/lib/components/split-pane.js
+++ b/lib/components/split-pane.js
@@ -167,6 +167,7 @@ export default class SplitPane extends Component {
 
       // this shim is used to make sure mousemove events
       // trigger in all the draggable area of the screen
+      //
       // this is not the case due to hterm's <iframe>
       shim: {
         position: 'fixed',
diff --git a/lib/hterm.js b/lib/hterm.js
index 7194bd4e..953e3311 100644
--- a/lib/hterm.js
+++ b/lib/hterm.js
@@ -7,7 +7,7 @@ hterm.defaultStorage = new lib.Storage.Memory();
 
 // Provide selectAll to terminal viewport
 hterm.Terminal.prototype.selectAll = function () {
-  // We need to clear dom range to reset anchorNode
+  // We need to clear the DOM range to reset anchorNode
   selection.clear(this);
   selection.all(this);
 };
@@ -207,7 +207,7 @@ hterm.Terminal.prototype.onMouse_ = function (e) {
   return oldOnMouse.call(this, e);
 };
 
-// sine above we're no longer relying on `preventDefault`
+// since above we're no longer relying on `preventDefault`
 // to avoid selections, we use css instead, so that
 // focus is not lost, but selections are still not possible
 // when the appropiate VT mode is set
diff --git a/lib/reducers/ui.js b/lib/reducers/ui.js
index 1c329064..5b22d609 100644
--- a/lib/reducers/ui.js
+++ b/lib/reducers/ui.js
@@ -90,7 +90,7 @@ const reducer = (state = initial, action) => {
     case CONFIG_RELOAD: // eslint-disable-line no-case-declarations
       const {config} = action;
       state_ = state
-        // we unset the user font size override if the
+        // unset the user font size override if the
         // font size changed from the config
         .merge((() => {
           const ret = {};
@@ -183,7 +183,7 @@ const reducer = (state = initial, action) => {
       break;
 
     case SESSION_RESIZE:
-      // We only care about the sizes
+      // only care about the sizes
       // of standalone terms (i.e. not splits):
       if (!action.isStandaloneTerm) {
         break;
@@ -233,7 +233,7 @@ const reducer = (state = initial, action) => {
         break;
       }
 
-      // we ignore activity markers that are within
+      // ignore activity markers that are within
       // proximity of a resize event, since we
       // expect to get data packets from the resize
       // of the ptys as a result
@@ -294,8 +294,7 @@ const reducer = (state = initial, action) => {
       break;
   }
 
-  // we check that if any of the font size values changed
-  // we show a notification
+  // Show a notification if any of the font size values have changed
   if (CONFIG_LOAD !== action.type) {
     if (state_.fontSize !== state.fontSize ||
         state_.fontSizeOverride !== state.fontSizeOverride) {
diff --git a/lib/utils/effects.js b/lib/utils/effects.js
index 9a5eca0c..db1cc61b 100644
--- a/lib/utils/effects.js
+++ b/lib/utils/effects.js
@@ -1,9 +1,11 @@
-// simple redux middleware that executes
-// the `effect` field if provided in an action
-// since this is preceded by the `plugins`
-// middleware, it allows authors to interrumpt,
-// defer or add to existing side effects at will
-// as the result of an action being triggered
+/**
+ * Simple redux middleware that executes
+ * the `effect` field if provided in an action
+ * since this is preceded by the `plugins`
+ * middleware. It allows authors to interrupt,
+ * defer or add to existing side effects at will
+ * as the result of an action being triggered.
+ */
 
 export default () => next => action => {
   const ret = next(action);
diff --git a/lib/utils/file.js b/lib/utils/file.js
index 32563735..40a1b60b 100644
--- a/lib/utils/file.js
+++ b/lib/utils/file.js
@@ -1,10 +1,14 @@
-// Based on https://github.com/kevva/executable
-// Since this module doesn't expose the function to check stat mode only,
-// his logic is pasted here.
-// Opened an issue and a pull request about it,
-// to maybe switch to module in the future:
-// Issue: https://github.com/kevva/executable/issues/9
-// PR: https://github.com/kevva/executable/pull/10
+/*
+ * Based on https://github.com/kevva/executable
+ * Since this module doesn't expose the function to check stat mode only,
+ * his logic is pasted here.
+ *
+ * Opened an issue and a pull request about it,
+ * to maybe switch to module in the future:
+ *
+ * Issue: https://github.com/kevva/executable/issues/9
+ * PR: https://github.com/kevva/executable/pull/10
+ */
 
 export function isExecutable(fileStat) {
   if (process.platform === 'win32') {
diff --git a/lib/utils/key-code.js b/lib/utils/key-code.js
index 835a5b43..dc4ae006 100644
--- a/lib/utils/key-code.js
+++ b/lib/utils/key-code.js
@@ -1,7 +1,7 @@
 /**
  * Keyboard event keyCodes have proven to be really unreliable.
  * This util function will cover most of the edge cases where
- * String.fromCharCode() will not work
+ * String.fromCharCode() doesn't work.
  */
 
 const _toAscii = {
@@ -54,7 +54,7 @@ const _arrowKeys = {
 /**
  * This fn takes a keyboard event and returns
  * the character that was pressed. This fn
- * purposely doens't take into account if the alt/meta
+ * purposely doesn't take into account if the alt/meta
  * key was pressed.
  */
 export default function fromCharCode(e) {
diff --git a/lib/utils/plugins.js b/lib/utils/plugins.js
index b0a76b9d..2b3e88b7 100644
--- a/lib/utils/plugins.js
+++ b/lib/utils/plugins.js
@@ -38,7 +38,7 @@ let termGroupPropsDecorators;
 let propsDecorators;
 let reducersDecorators;
 
-// the fs locations where usr plugins are stored
+// the fs locations where user plugins are stored
 const {path, localPath} = plugins.getBasePaths();
 
 const clearModulesCache = () => {
@@ -52,7 +52,7 @@ const clearModulesCache = () => {
   // clear require cache
   for (const entry in window.require.cache) {
     if (entry.indexOf(path) === 0 || entry.indexOf(localPath) === 0) {
-      // `require` is webpacks', `window.require`, electron's
+      // `require` is webpacks', `window.require` is electron's
       delete window.require.cache[entry];
     }
   }
diff --git a/lib/utils/selection.js b/lib/utils/selection.js
index 63f01149..e99a207a 100644
--- a/lib/utils/selection.js
+++ b/lib/utils/selection.js
@@ -1,4 +1,4 @@
-//  clear selection range of current selected term view
+//  Clear selection range of current selected term view
 //  Fix event when terminal text is selected and keyboard action is invoked
 exports.clear = function (terminal) {
   terminal.document_.getSelection().removeAllRanges();