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
mpintaric55334 wants to merge 5 commits intomasterfrom
Open
[master < xml_module] Write docs for xml module#1026mpintaric55334 wants to merge 5 commits intomasterfrom
mpintaric55334 wants to merge 5 commits intomasterfrom
Conversation
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
| #### Input: | ||
|
|
||
| - `xml_input: string` ➡ input XML string. | ||
| - `simple: bool (default = false)` ➡ bool used for specifying whether simple mode should be used. |
Collaborator
There was a problem hiding this comment.
link to the explanation of the simple mode
Collaborator
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
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
vpavicic
reviewed
Sep 11, 2023
|
|
||
| #### Simple configuration explanation | ||
|
|
||
| For details about simple configuration, go to [**Simple configuration explanation in parse function**](#simple-configuration-explanation). |
Collaborator
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
vpavicic
reviewed
Sep 11, 2023
|
|
||
| #### 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. |
Collaborator
There was a problem hiding this comment.
Why isn't this in the intro part of the procedure?
Contributor
Author
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
reviewed
Sep 11, 2023
vpavicic
added
status: change
mpintaric55334
added
status: ready
vpavicic
reviewed
Sep 12, 2023
vpavicic
approved these changes
Sep 12, 2023
vpavicic
added
status: ship it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: