Skip to content

Commit

Permalink
Enhance description of when to use parser
Browse files Browse the repository at this point in the history
  • Loading branch information
djaglowski committed Oct 11, 2024
1 parent 4051b7f commit 4534dc0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions pkg/ottl/ottlfuncs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,7 @@ Available Converters:
- [ParseCSV](#parsecsv)
- [ParseJSON](#parsejson)
- [ParseKeyValue](#parsekeyvalue)
- [ParseSimplifiedXML](#parsesimplifiedxml)
- [ParseXML](#parsexml)
- [RemoveXML](#removexml)
- [Seconds](#seconds)
Expand Down Expand Up @@ -1341,8 +1342,8 @@ Examples:

The `ParseSimplifiedXML` Converter returns a `pcommon.Map` struct that is the result of parsing the target string without preservation of attributes or extraneous text content.

The goal of this Converter is to produce a more user-friendly representation of XML data than the `ParseXML` Converter,
which produces a verbose *encoding* of XML data.
The goal of this Converter is to produce a more user-friendly representation of XML data than the `ParseXML` Converter.
This Converter should be preferred over `ParseXML` when minor semantic details (e.g. order of elements) are not critically important, when subsequent processing or querying of the result is expected, or when human-readability is a concern.

This Converter disregards certain aspects of XML, specifically attributes and extraneous text content, in order to produce
a direct representation of XML data. Users are encouraged to simplify their XML documents prior to using `ParseSimplifiedXML`.
Expand Down

0 comments on commit 4534dc0

Please sign in to comment.