Skip to content

Commit 4ecfaad

Browse files
committed
Update with comments
1 parent 05dfeec commit 4ecfaad

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/developing-flows/documenting-flows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Along with the label, nodes can also have a custom icon. For example, if you hav
6565

6666
Choosing good names for things applies just as much to the tabs and subflows used.
6767

68-
It also very important for Link nodes. Without a name set, you have to use the Link node's internal ID when creating links between different tabs. That makes it hard to identify the right target node and mistakes can happen. If you consider the Link nodes as providing APIs between the different tabs, then a good choice of naming scheme will be needed.
68+
It also very important for Link nodes. Without a name set, you have to use the Link node's internal ID when creating links between different tabs. That makes it hard to identify the right target node and mistakes can happen. If you consider the Link nodes as providing APIs between the different tabs, then a good choice of naming scheme will be needed. The names should clearly identify the start and end point of each flow.
6969

7070
### Adding port labels
7171

docs/developing-flows/flow-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Subflows let you create a new node in the palette whose internal implementation
4646
</div>
4747

4848

49-
There are some important differences between the two approaches. Link nodes cannot be used in the middle of a flow, where messages are passed over the link and then return when the other flow completes. They can only be used to start or end a flow. They can also be connect to more than one other link node. This lets you pass messages out to multiple other flows, or have multiple flows pass messages into a single flow.
49+
There are some important differences between the two approaches. Link nodes cannot be used in the middle of a flow, where messages are passed over the link and then return when the other flow completes. They can only be used to start or end a flow. They can also be connected to more than one other link node. This lets you pass messages out to multiple other flows, or have multiple flows pass messages into a single flow. They can be used within a single tab to help flows wrap across the workspace without having lots of wires crossing from right to left.
5050

5151
Subflows appear as regular nodes so can be used at any point in a flow. However each instance of the subflow is independent of the others. Any flow context inside the subflow will be scoped to the individual instances. If the subflow creates a connection to a remote system, each instance will create its own connection.
5252

@@ -79,7 +79,7 @@ This pattern can be applied to any node configuration field that lets you enter
7979

8080
Another consideration is how to manage any state information in your flows. For example, keeping a count of how many messages pass through a flow, or the current state of an external sensor.
8181

82-
Node-RED provides the Context system for managing state within the runtime. The context can be scoped to the same tab, subflow or made globally available.
82+
Node-RED provides the Context system for managing state within the runtime. The context can be scoped to the same tab, subflow or made available globally.
8383

8484
If a piece of state information is only needed by nodes on a particular tab, you should use flow-scoped rather than global. You should also choose context variable names with care - make sure they are descriptive and easy to identify.
8585

0 commit comments

Comments
 (0)