davidradl commented on code in PR #27294:
URL: https://github.com/apache/flink/pull/27294#discussion_r2580379909
##########
flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/ExecNodeMetadata.java:
##########
@@ -33,14 +34,14 @@
/**
* Annotation to be used for {@link ExecNode}s to keep necessary metadata when
- * serializing/deserializing them in a plan. It's used for internal
bookkeeping across Flink
- * versions, and to provide necessary information to the testing
infrastructure.
+ * serializing/deserializing them into a {@link CompiledPlan}. It's used for
internal bookkeeping
+ * across Flink versions, and to provide necessary information to the testing
infrastructure.
*
* <p>Each {@link ExecNode} needs to be annotated and provide the necessary
metadata info so that it
- * can be correctly serialized and later on instantiated from a string (JSON)
plan.
+ * can be correctly serialized and later on instantiated from a JSON plan.
*
- * <p>It's possible for one {@link ExecNode} class to use multiple annotations
to denote ability to
- * upgrade to more versions. an {@link ExecNode} class can be annotated
directly with multiple
+ * <p>It's possible for one {@link ExecNode} class to use multiple annotations
to denote the ability
+ * to upgrade to more versions. an {@link ExecNode} class can be annotated
directly with multiple
Review Comment:
I do not understand this bit. When we say
```
use multiple annotations to denote the ability to upgrade to more versions
```
I am not sure how the annotations relate to the ability to upgrade. There
appears to be an implication that having multiple annotations means we could go
to multiple Flink versions. But these Fink versions (I assume) are ones that
may not have have been released yet. I wonder if we could reword this sentence
to make it clearer, maybe including example annotations and versions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
