summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-12-14 05:33:42 +0000
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-12-14 05:33:42 +0000
commit4f096964968b9671a2fd43d1054e77eda0630ac7 (patch)
treebe22ebbfe800d49c4ff9a8e7894d046d53b71eb9
parent430082c0134db7d8a82b5316fe9d6d7b766452b4 (diff)
* lib/xmlrpc.rb: added documentation for parser details.
[ci skip][fix GH-1124] Patch by @jrafanie git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@53107 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--ChangeLog5
-rw-r--r--lib/xmlrpc.rb12
2 files changed, 16 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index d654377..4f86996 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Mon Dec 14 14:33:35 2015 SHIBATA Hiroshi <hsbt@ruby-lang.org>
+
+ * lib/xmlrpc.rb: added documentation for parser details.
+ [ci skip][fix GH-1124] Patch by @jrafanie
+
Mon Dec 14 11:46:52 2015 SHIBATA Hiroshi <hsbt@ruby-lang.org>
* enum.c: fix a typo in documentation.
diff --git a/lib/xmlrpc.rb b/lib/xmlrpc.rb
index 511c57d..8cad6a1 100644
--- a/lib/xmlrpc.rb
+++ b/lib/xmlrpc.rb
@@ -53,9 +53,19 @@
#
# * Parsers
# * NQXML (XMLParser::NQXMLStreamParser, XMLParser::NQXMLTreeParser)
+# * Not compiled (pure ruby)
+# * Note: NQXML's website recommends rexml and isn't available on rubygems.org
+# * See http://nqxml.sourceforge.net/
# * Expat (XMLParser::XMLStreamParser, XMLParser::XMLTreeParser)
+# * Compiled
+# * Fastest parser and also uses the least memory
+# * See https://rubygems.org/gems/xmlparser
# * REXML (XMLParser::REXMLStreamParser)
+# * Not compiled (pure ruby)
+# * See ruby standard library
# * xml-scan (XMLParser::XMLScanStreamParser)
+# * Not compiled (pure ruby)
+# * See https://rubygems.org/gems/xmlscan
# * Fastest parser is Expat's XMLParser::XMLStreamParser!
#
# * General
@@ -292,7 +302,7 @@
# # ...
#
#
-# Note that XMLParser::XMLStreamParser is incredible faster (and uses less memory) than any
+# Note XMLParser::XMLStreamParser (xmlparser gem) is faster and uses less memory than any
# other parser and scales well for large documents. For example for a 0.5 MB XML
# document with many tags, XMLParser::XMLStreamParser is ~350 (!) times faster than
# XMLParser::NQXMLTreeParser and still ~18 times as fast as XMLParser::XMLTreeParser.