Merge pull request #55 from bem/issue53

correct some grammatical mistakes

Author: eGavr

README.md

@@ -140,7 +140,7 @@ Options:
   -h, --help : Help
   -v, --version : Shows the version number
   --config=CONFIG : Path to configuration JSON-file
-  --chars-around-diff=CHARSAROUNDDIFF : The number of characters around diff
+  --chars-around-diff=CHARSAROUNDDIFF : The number of characters around the diff
 
 Arguments:
   PATH1 : Path to the 1-st html-file (required)

lib/cli.js

@@ -29,7 +29,7 @@ module.exports = require('coa').Cmd()
         .end()
     .opt()
         .name('charsAroundDiff')
-        .title('Number of characters around diff')
+        .title('The number of characters around the diff')
         .long('chars-around-diff')
         .val(function(val) {
             return parseInt(val);

lib/diff-logger.js

@@ -13,7 +13,7 @@ function getDiffText(diff, options) {
     };
 
     if (options.showCharacters) {
-        console.log('Option "showCharacters" is deprecated, please use "charsAroundDiff"');
+        console.log('Option \'showCharacters\' is deprecated, please, use \'charsAroundDiff\'');
         options.charsAroundDiff = options.showCharacters;
     }
 

lib/index.js

@@ -6,7 +6,7 @@ var utils = require('./utils'),
     _ = require('lodash');
 
 /**
- * Converts HTML document to AST Tree
+ * Converts the HTML document to the AST Tree
  * @param {String} HTMLDoc
  * @param {Object} options
  * @returns {AST}
@@ -26,7 +26,7 @@ function htmlToAST(HTMLDoc, options) {
 }
 
 /**
- * Recursively sorts the arttibutes value of the AST leafs
+ * Recursively sorts arttibutes' values of the AST leafs
  * @param {AST} tree
  * @param {Object} options
  * @returns {AST}
@@ -89,7 +89,7 @@ var Diff = diff.Diff;
 HtmlDiff.prototype = Diff.prototype;
 
 /**
- * Tokenizes a given string
+ * Tokenizes the given string
  * @param {String} value
  * @returns {Array}
  */
@@ -139,7 +139,7 @@ var HtmlDiffer = function(options) {
  */
 HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
     if (options) {
-        console.warn('WARNING! The third param of "diffHtml" method is deprecated!');
+        console.warn('WARNING! The third param of \'diffHtml\' method is deprecated!');
     }
 
     options = _.defaults(this.options, options);
@@ -158,7 +158,7 @@ HtmlDiffer.prototype.diffHtml = function(html1, html2, options) {
  */
 HtmlDiffer.prototype.isEqual = function(html1, html2, options) {
     if (options) {
-        console.warn('WARNING! The third param of "isEqual" method is deprecated!');
+        console.warn('WARNING! The third param of \'isEqual\' method is deprecated!');
     }
 
     options = _.defaults(this.options, options);

lib/utils.js

@@ -1,7 +1,7 @@
 var _ = require('lodash');
 
 /**
- * Sorts recursively given object by key
+ * Recursively sorts the given object by key
  * @param {Object} obj
  * @returns {Object}
  */
@@ -23,7 +23,7 @@ exports.sortObj = function sortObj(obj) {
 };
 
 /**
- * Parses a json string given in HTML attribute
+ * Parses the JSON given in HTML attribute
  * @param {String} val
  * @param {Boolean} [isClick]
  * @returns {Object}