Unify comments in README with TS comments (#76)

Author: kevgo

README.md

@@ -16,16 +16,19 @@ verifying the equality of larger strings or data structures in tests.
 ```javascript
 import * as assertNoDiff from "assert-no-diff"
 
-// assert no differences between two JavaScript objects
+// Diffs two JSON objects, comparing the fields defined on each.
+// The order of fields does not matter.
 assertNoDiff.json(actualJson, expectedJson)
 
-// compare strings and highlight the differences character-by-character
+// Asserts that two blocks of text are equal, comparing character by character.
 assertNoDiff.chars(actualString, expectedString)
 
-// compare strings and highlight the mismatching words, whitespace-sensitive
+// Diffs two blocks of text, comparing word by word.
+// Whitespace is significant.
 assertNoDiff.wordsWithSpace(actualString, expectedString)
 
-// compare strings and highlight the mismatching lines, ignoring whitespace around them
+// Diffs two blocks of text, comparing line by line.
+// Ignores leading and trailing whitespace.
 assertNoDiff.trimmedLines(actualString, expectedString)
 ```
 

src/index.ts

@@ -25,7 +25,7 @@ export function chars(
 
 /**
  * Diffs two JSON objects, comparing the fields defined on each.
- * The order of fields, etc does not matter.
+ * The order of fields does not matter.
  *
  * @throws a bash-colored error if the arguments are not equal
  */
@@ -47,7 +47,8 @@ export function json(
 }
 
 /**
- * Diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.
+ * Diffs two blocks of text, comparing line by line.
+ * Ignores leading and trailing whitespace.
  *
  * @throws a bash-colored error if the arguments are not equal
  */
@@ -69,7 +70,8 @@ export function trimmedLines(
 }
 
 /**
- * Diffs two blocks of text, comparing word by word, treating whitespace as significant.
+ * Diffs two blocks of text, comparing word by word.
+ * Whitespace is significant.
  *
  * @throws a bash-colored error if the arguments are not equal
  */