Skip to content

Commit e1076c6

Browse files
committed
update docs
1 parent e4d09fe commit e1076c6

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

doc.go

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Related Packages:
1414
checkxml: github.com/clbanning/checkxml provides functions for validating XML data.
1515
1616
Notes:
17+
2022.10.20: v2.6 - add NewMapForattedXmlSeq for XML docs formatted with whitespace character
18+
2021.02.02: v2.5 - add XmlCheckIsValid toggle to force checking that the encoded XML is valid
19+
2020.12.14: v2.4 - add XMLEscapeCharsDecoder to preserve XML escaped characters in Map values
20+
2020.10.28: v2.3 - add TrimWhiteSpace option
1721
2020.05.01: v2.2 - optimize map to XML encoding for large XML docs.
1822
2019.07.04: v2.0 - remove unnecessary methods - mv.XmlWriterRaw, mv.XmlIndentWriterRaw - for Map and MapSeq.
1923
2019.07.04: Add MapSeq type and move associated functions and methods from Map to MapSeq.

readme.md

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ For over a year I've wanted to refactor the XML-to-map[string]interface{} decode
4242

4343
<h4>Notices</h4>
4444

45+
2022.10.20: v2.6 - add NewMapForattedXmlSeq for XML docs formatted with whitespace character
4546
2021.02.02: v2.5 - add XmlCheckIsValid toggle to force checking that the encoded XML is valid
4647
2020.12.14: v2.4 - add XMLEscapeCharsDecoder to preserve XML escaped characters in Map values
4748
2020.10.28: v2.3 - add TrimWhiteSpace option

xmlseq.go

+2
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ var NO_ROOT = NoRoot // maintain backwards compatibility
8181
// ERRORS:
8282
// 1. If a NoRoot error, "no root key," is returned, check the initial map key for a "#comment",
8383
// "#directive" or #procinst" key.
84+
// 2. Unmarshaling an XML doc that is formatted using the whitespace character, " ", will error, since
85+
// Decoder.RawToken treats such occurances as significant. See NewMapFormattedXmlSeq().
8486
func NewMapXmlSeq(xmlVal []byte, cast ...bool) (MapSeq, error) {
8587
var r bool
8688
if len(cast) == 1 {

0 commit comments

Comments
 (0)