Skip to content

Conversation

@ninjeeter
Copy link
Contributor

No description provided.

@ninjeeter ninjeeter requested a review from Sytten January 7, 2025 19:51
@caidobot caidobot temporarily deployed to AP-Workflows - doc-developer PR #34 January 7, 2025 19:52 — with Render Destroyed
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2025

Images automagically compressed by Calibre's image-actions

Compression reduced images by 31.6%, saving 74.00 KB.

Filename Before After Improvement Visual comparison
src/_images/data_flow.png 150.00 KB 101.51 KB -32.3% View diff
src/_images/execution_flow.png 83.90 KB 58.39 KB -30.4% View diff

27 images did not require optimisation.

@caidobot caidobot temporarily deployed to AP-Workflows - doc-developer PR #34 January 7, 2025 19:52 — with Render Destroyed
Copy link
Member

@Sytten Sytten left a comment

Choose a reason for hiding this comment

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

Good first pass. Though this documentation should live in the main doc, not the developer doc. Lets switch repo :)

:::

``` rust
pub enum NodeDataProp {
Copy link
Member

Choose a reason for hiding this comment

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

Lets not dump a rust enum here, most of that data is unnecessary and hard to read for users.
This was mostly a reference for you to craft the documentation around it.

}
```

With this typed data system, even though Nodes are processed sequentially, you do not need a direct line between two Nodes in order to pass data from one to another.
Copy link
Member

Choose a reason for hiding this comment

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

We use the alias system for that. Unsure if we explained it elsewhere, but this is the place to write about it.
So [node_alias].[output_alias] is the format we use.

:::

``` rust
pub enum NodeDataProp {
Copy link
Member

Choose a reason for hiding this comment

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

Same comment as for concept, we dont want to just dump a rust enum here. We want a real reference.
Also what is more important here is the automatic conversion between types which is not present.

@ninjeeter ninjeeter closed this Jan 14, 2025
@ninjeeter ninjeeter deleted the AP-Workflows branch January 14, 2025 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants