From: Jason Woofenden <jason@jasonwoof.com>
Date: Sun, 14 May 2017 02:37:42 +0000 (-0400)
Subject: improve comments
X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=commitdiff_plain;h=584a8ec2c766c03b2d7fd28000af57f11fba3cca

improve comments
---

diff --git a/editor.js b/editor.js
index 83cc246..564befc 100644
--- a/editor.js
+++ b/editor.js
@@ -225,7 +225,8 @@ function new_cursor_position (args) {
 	return null
 }
 
-// encode text so it can be safely placed inside an html attribute
+// html encoding for attributes
+// encoding nbsp is not required, but hopefully it is useful
 enc_attr_regex = new RegExp('(&)|(")|(\u00A0)', 'g')
 function enc_attr (txt) {
 	return txt.replace(enc_attr_regex, function(match, amp, quote) {
@@ -238,6 +239,8 @@ function enc_attr (txt) {
 		return '&nbsp;'
 	})
 }
+// html encoding for text (does nothing to stop whitespace collapse)
+// encoding nbsp is not required, but hopefully it is useful
 enc_text_regex = new RegExp('(&)|(<)|(\u00A0)', 'g')
 function enc_text (txt) {
 	return txt.replace(enc_text_regex, function(match, amp, lt) {