[master < xml_module] Write docs for xml module #1026
Conversation
| #### Input: | ||
|
|
||
| - `xml_input: string` ➡ input XML string. | ||
| - `simple: bool (default = false)` ➡ bool used for specifying whether simple mode should be used. |
There was a problem hiding this comment.
link to the explanation of the simple mode
There was a problem hiding this comment.
that heading is called simple configuration, should this explanation also use the word configuration so i can connect these two
|
|
||
| #### Simple configuration explanation | ||
|
|
||
| For details about simple configuration, go to [**Simple configuration explanation in parse function**](#simple-configuration-explanation). |
There was a problem hiding this comment.
I think I would add this explanation to the introduction. SOmething like -you can choose to execute the procedure in a simple and then explain what it means... so when i am already reading about procedures i know what it is + no header necessary, no repetition in each procedure
|
|
||
| #### XPath | ||
|
|
||
| This procedure supports the usage of XPath expressions. Since the module is implemented in Python, XPath expressions should follow, and are limited to the XPath syntax explained here [**XML python docs**](https://docs.python.org/3/library/xml.etree.elementtree.html#xpath-support). XPath implemented this way cannot use absolute paths, so one of these 3 prefixes must be used to avoid errors: `. .. *`. The current node is the root node. |
There was a problem hiding this comment.
Why isn't this in the intro part of the procedure?
There was a problem hiding this comment.
Because XPath is not the main purpose of the function, its more a side addition for users who want to use it
vpavicic
added
status: change
mpintaric55334
added
status: ready
vpavicic
added
status: ship it
Description
Please briefly explain the changes you made here.
I wrote a dosc page for xml_module QM in MAGE.
Pull request type
Please delete options that are not relevant and check the ones that are.
Related PRs and issues
PR this doc page is related to:
memgraph/mage#329
Closes (link to issue):
Checklist: