Node: Clarify Usage of Setup in Function Declaration #31535
Merged
+3
−3
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
The comment for the base Node setup class currently reads as follows:
For some, this can be misconstrued as all setup nodes requiring a returned outputNode. However, in many nodes, this is not the case. Examples include ConditionalNode, LoopNode, LightProbeNode, IrradianceNode, HemisphereLightNode, AONode, AnalyticLightNode, VaryingNode, ContextNode, and more. These nodes often perform actions that are not captured by the description in the setup function declaration, including modifying the context or creating new nodes. Additionally, many of these node are built under the assumption that setup() will not return and will fallback to properties.outputNode or null with Node.js
Accordingly, I think the declaration for the setup function should more explicitly indicate that a returned outputNode is not necessary for every setup declaration.