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

[master < E-mage-refactor] Add docs for mage refactor module #1021

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

Conversation

imilinovic
Copy link
Contributor

@imilinovic imilinovic commented Sep 6, 2023

Description

Add docs for mage refactor module

Pull request type

Please delete options that are not relevant and check the ones that are.

  • New documentation page

Related PRs and issues

PR this doc page is related to:
PR342
Closes (link to issue):

Checklist:

  • I checked all content with Grammarly
  • I performed a self-review of my code
  • I made corresponding changes to the rest of the documentation
  • The build passes locally
  • My changes generate no new warnings or errors

@imilinovic imilinovic added the status: draft PR is in draft phase label Sep 6, 2023
@imilinovic imilinovic self-assigned this Sep 6, 2023
@imilinovic imilinovic added status: ready PR is ready for review and removed status: draft PR is in draft phase labels Sep 11, 2023
@imilinovic imilinovic marked this pull request as ready for review September 11, 2023 05:19
| Name | Type | Default | Description |
|- |- |- |- |
| skipProperties | List | [ ] | A list of property keys. Properties associated with these keys will be skipped during the cloning process therefore new nodes will not have them.|
| standinNodes | List | [ ] | A list of pairs (lists with only two elements) where: 1) The first element is the original node (from the input nodes list) that you're planning to clone. 2) The second element is an existing node in the graph that will "stand in" or replace the clone of the original node in the resultant subgraph. |
Copy link
Collaborator

@vpavicic vpavicic Sep 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| standinNodes | List | [ ] | A list of pairs (lists with only two elements) where: 1) The first element is the original node (from the input nodes list) that you're planning to clone. 2) The second element is an existing node in the graph that will "stand in" or replace the clone of the original node in the resultant subgraph. |
| standinNodes | List | [ ] | A list of pairs (lists with only two elements) where the first element is the original node (from the input nodes list) that you're planning to clone, and the second element is an existing node in the graph that will "stand-in" or replace the clone of the original node in the resultant subgraph. |

@vpavicic vpavicic added status: ship it PR approved and removed status: ready PR is ready for review labels Sep 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants