dawidwys commented on a change in pull request #6303:
[hotfix][JobManageOptions]modify annotation of EXECUTION_FAILOVER_STRATEGY in
JobManageOptions
URL: https://github.com/apache/flink/pull/6303#discussion_r208237925
##########
File path:
flink-core/src/main/java/org/apache/flink/configuration/JobManagerOptions.java
##########
@@ -102,12 +104,21 @@
.withDescription("The maximum number of prior execution
attempts kept in history.");
/**
- * The maximum number of prior execution attempts kept in history.
+ * This options specifies the failover strategy.
*/
public static final ConfigOption<String> EXECUTION_FAILOVER_STRATEGY =
key("jobmanager.execution.failover-strategy")
.defaultValue("full")
- .withDescription("The maximum number of prior execution
attempts kept in history.");
+ .withDescription(Description.builder()
+ .text("This options specifies the job
computation recovers from task failures.")
+ .linebreak()
+ .text("Accepted values are:")
+ .linebreak()
Review comment:
I think lists always render in a separate line. So I would say this
`linebreak` is unnecessary. The linebreak before `Accepted values are:` is also
questionable right now. It renders like this:
I would either remove the line break or add two linebreaks to render empty
line.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
