From 8768da7339dfcb422c53df3542b63e55c99af3a0 Mon Sep 17 00:00:00 2001 From: Gabriel Martin Date: Mon, 5 Jan 2015 18:49:41 +0000 Subject: [PATCH] Tidy up comments on tests --- .gitignore | 1 + test/spec/allVersions.spec.js | 11 ++++++----- test/spec/currentVersion.spec.js | 8 ++++---- 3 files changed, 11 insertions(+), 9 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fa0fd2b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +TODO.txt \ No newline at end of file diff --git a/test/spec/allVersions.spec.js b/test/spec/allVersions.spec.js index 17c7e94..5f1d2ce 100644 --- a/test/spec/allVersions.spec.js +++ b/test/spec/allVersions.spec.js @@ -1,14 +1,15 @@ /* -** Test that a given input results in an output that can -** be decoded to match the original input. Applicable to -** all versions. +** Test that when you take an IP address, encode it, and then decode it +** again, it matches the original address. These tests are applicable to +** all versions of Hipku, regardless of changes to the dictionaries or +** schema. */ var Hipku = require('../../index.js'); describe("All versions of Hipku", function() { - it("should symetrically encode and decode IPv4 addresses", function() { + it("should symmetrically encode and decode IPv4 addresses", function() { expect( Hipku.decode(Hipku.encode('0.0.0.0')) ).toBe('0.0.0.0'); @@ -26,7 +27,7 @@ describe("All versions of Hipku", function() { ).toBe('255.255.255.255'); }); - it("should symetrically encode and decode IPv6 addresses", function() { + it("should symmetrically encode and decode IPv6 addresses", function() { expect( Hipku.decode(Hipku.encode('0:0:0:0:0:0:0:0')) diff --git a/test/spec/currentVersion.spec.js b/test/spec/currentVersion.spec.js index cea21c1..f125c9b 100644 --- a/test/spec/currentVersion.spec.js +++ b/test/spec/currentVersion.spec.js @@ -1,8 +1,8 @@ /* -** Test that a series of inputs match the outputs -** specified by the current version's dictionaries -** and schemas. Tests must be updated whenever changes -** are made to any dicationary or schema. +** Test that a series of encoded test IPs match haiku for the current +** set of dictionaries and schema, and that a series of decoded test +** haiku match IPs for the current dictionaries and schema. These tests +** must be updated whenever the dictionaries or schema are changed. */ var Hipku = require('../../index.js');