[FLINK-15501] Remove the wrong doc of ExecutionVertexSchedulingRequirements#getExecutionVertexId

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Done
• Fix Version/s: 1.11.0
• Component/s: Runtime / Coordination
• Labels: pull-request-available
• Assignee: vinoyang
• Reporter: vinoyang
• Created: 07/Jan/20 13:03
• Updated: 07/Jan/20 15:01
• Resolved: 07/Jan/20 15:01

Description

Currently, ExecutionVertexSchedulingRequirements#getExecutionVertexId's doc is:

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

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.

Issue Links

• links to: GitHub Pull Request #10790