From: Jason Woofenden <jason@jasonwoof.com>
Date: Thu, 21 Jan 2016 17:33:08 +0000 (-0500)
Subject: update comments
X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=commitdiff_plain;h=91c18ac7f22e21189d7fa610cecd208d389550d9

update comments
---

diff --git a/parse-html.coffee b/parse-html.coffee
index 9729874..9f3292b 100644
--- a/parse-html.coffee
+++ b/parse-html.coffee
@@ -36,12 +36,10 @@
 ## how to use this code
 ##################################
 #
-# See README.md for how to pre-compile this file, or compile it in the browser.
+# See README.md for how to run this file in the browser or in node.js.
 #
-# This file exports a single useful function: parse_tml
-#
-# Once you include this file in a page (see index.html for an example) you'll
-# have window.wheic
+# This file exports a single useful function: parse_tml, and some constants
+# (see the bottom of this file for those.)
 #
 # Call it like this:
 #
@@ -51,11 +49,7 @@
 #
 #     wheic.parse_html({fragment: "body", html: "<p><b>hi</p>"})
 #
-# This code can _almost_ run outside the browser (eg under node.js). To get it
-# to run without the browser would require native implementation of
-# decode_named_char_ref(). The current implementation of that function uses the
-# browser's DOM api, to save space (the list of valid named characters is
-# massive.)
+# return value is an array of Nodes, see "class Node" below.
 
 # This code is a work in progress, eg try search this file for "fixfull",
 # "TODO" and "FIXME"
@@ -71,7 +65,7 @@
 #
 # example: open_els = [a, b, c, d, e, f, g]
 #
-# "grows downwards" means it's visualized like this: (index: el, names)
+# "grows downwards" means it's visualized like this: (index: el "names")
 #
 #   6: g "start of the list", "topmost", "first"
 #   5: f