[
https://issues.apache.org/jira/browse/FLINK-30009?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yunfeng Zhou updated FLINK-30009:
---------------------------------
Description:
The following description lies in the JavaDoc of
{{OperatorCoordinator.start()}}.
{{This method is called once at the beginning, before any other methods.}}
This description is incorrect because the method {{resetToCheckpoint()}} can be
invoked before {{start()}}. For example,
{{RecreateOnResetOperatorCoordinator.DeferrableCoordinator.resetAndStart()}}
uses these methods in this way. Thus the JavaDoc of {{OperatorCoordinator}}'s
methods should be modified to match this behavior.
was:
The following description lies in the JavaDoc of
{{OperatorCoordinator.start()}}.
{{This method is called once at the beginning, before any other methods.}}
This description is incorrect because the method {{resetToCheckpoint()}} can
happen before {{start()}} is invoked. For example,
{{RecreateOnResetOperatorCoordinator.DeferrableCoordinator.resetAndStart()}}
uses these methods in this way. Thus the JavaDoc of {{OperatorCoordinator}}'s
methods should be modified to match this behavior.
> OperatorCoordinator.start()'s JavaDoc mismatches its behavior
> -------------------------------------------------------------
>
> Key: FLINK-30009
> URL: https://issues.apache.org/jira/browse/FLINK-30009
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.16.0
> Reporter: Yunfeng Zhou
> Priority: Major
>
> The following description lies in the JavaDoc of
> {{OperatorCoordinator.start()}}.
> {{This method is called once at the beginning, before any other methods.}}
> This description is incorrect because the method {{resetToCheckpoint()}} can
> be invoked before {{start()}}. For example,
> {{RecreateOnResetOperatorCoordinator.DeferrableCoordinator.resetAndStart()}}
> uses these methods in this way. Thus the JavaDoc of {{OperatorCoordinator}}'s
> methods should be modified to match this behavior.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
