Skip to content
This repository was archived by the owner on Sep 18, 2023. It is now read-only.

[master < xml_module] Write docs for xml module #1026

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[master < xml_module] Write docs for xml module #1026

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a977207
Write docs for xml module
mpintaric55334 Sep 8, 2023
2ccfd44
Small change
mpintaric55334 Sep 8, 2023
813e7a3
Apply suggestions from code review
vpavicic Sep 11, 2023
810af8b
PR changes
mpintaric55334 Sep 11, 2023
067e5bb
Apply suggestions from code review
vpavicic Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions mage/query-modules/python/xml_module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Parses an XML string or file into a map. Since this is a function and not a proc
#### Input:

- `xml_input: string` ➡ input XML string.
- `simple: bool (default = false)` ➡ bool used for specifying whether simple mode should be used.
- `path: string (default = "")` ➡ path to the XML file that needs to be parsed. If the path is not empty, the `xml_input` string is ignored, and only the file is parsed.
- `simple: bool (default = false)` ➡ configuration bool used for specifying whether simple mode should be used. [**Simple configuration explanation**](#simple-configuration-explanation).
- `path: string (default = "")` ➡ path to the XML file that needs to be parsed. If the path is not empty, the `xml_input` string is ignored, and only the file is parsed.

#### Output:

Expand Down Expand Up @@ -319,7 +319,7 @@ Output:

### `load(xml_url, simple, path, xpath, headers)`

Loads and parses an XML file from a URL or a local file. Supports simple mode, and XPath expressions.
Loads and parses an XML file from a URL or a local file. Supports simple mode, and XPath expressions. You can choose to execute the procedure in simple mode => [**Simple configuration explanation**](#simple-configuration-explanation).

#### Input:

Expand All @@ -335,9 +335,6 @@ Loads and parses an XML file from a URL or a local file. Supports simple mode, a

If the XPath expression is not empty, the output is all elements that satisfy the expression.

#### Simple configuration explanation

For details about simple configuration, go to [**Simple configuration explanation in parse function**](#simple-configuration-explanation).

#### XPath

Expand Down