[jira] [Created] (FLINK-15501) Remove the wrong doc of ExecutionVertexSchedulingRequirements#getExecutionVertexId

[Shang Yuanchun (Jira)]

vinoyang created FLINK-15501:
--------------------------------

             Summary: Remove the wrong doc of ExecutionVertexSchedulingRequirements#getExecutionVertexId
                 Key: FLINK-15501
                 URL: https://issues.apache.org/jira/browse/FLINK-15501
             Project: Flink
          Issue Type: Improvement
          Components: Runtime / Coordination
            Reporter: vinoyang


Currently, {{ExecutionVertexSchedulingRequirements#getExecutionVertexId}}'s doc is:


{code:java}
/**
 * a {@link ExecutionVertex#MAX_DISTINCT_LOCATIONS_TO_CONSIDER} test.
 *
 * @return
 */
{code}

It has a {{@return}} but missed relevant descriptions. However, when analysis of the call chain, it shows that it is called via general code(not only for testing purposes).

So, IMO, we either correct the java doc or remove it directly.

Based on the style in the same file, I suggest that we can remove it.




--
This message was sent by Atlassian Jira
(v8.3.4#803005)