From 2e1af15cb157dbcd6b252eac2f0b77112b6564b6 Mon Sep 17 00:00:00 2001
From: John Evans <john.g.evans.ne@gmail.com>
Date: Fri, 4 Apr 2014 13:54:58 -0400
Subject: [PATCH] Adjusted some comments in XML box parsing.  #213

---
 glymur/jp2box.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/glymur/jp2box.py b/glymur/jp2box.py
index 5ea275b..b983cbe 100644
--- a/glymur/jp2box.py
+++ b/glymur/jp2box.py
@@ -2738,6 +2738,7 @@ class XMLBox(Jp2kBox):
             # Try to search for <?xml and go from there.
             decl_start = read_buffer.find(b'<?xml')
             if decl_start <= -1:
+                # Nope, that's not it.  All is lost.
                 msg = 'A problem was encountered while parsing an XML box:'
                 msg += '\n\n\t"{0}"\n\nNo XML was retrieved.'
                 warnings.warn(msg.format(str(err)))
@@ -2752,14 +2753,16 @@ class XMLBox(Jp2kBox):
             warnings.warn(msg, UserWarning)
 
         # Strip out any trailing nulls, as they can foul up XML parsing.
-        # Remove any byte order markers.
         text = text.rstrip(chr(0))
+
+        # Remove any byte order markers.
         if u'\ufeff' in text:
             msg = 'An illegal BOM (byte order marker) was detected and '
             msg += 'removed from the XML contents in the box starting at byte '
             msg += 'offset {0}'.format(offset)
             warnings.warn(msg)
             text = text.replace(u'\ufeff', '')
+
         # Remove any encoding declaration.
         if text.startswith('<?xml version="1.0" encoding="UTF-8"?>'):
             text = text[38:]