[
https://issues.apache.org/jira/browse/FLINK-9871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16549155#comment-16549155
]
ASF GitHub Bot commented on FLINK-9871:
---------------------------------------
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/6371#discussion_r203692344
--- Diff:
flink-core/src/main/java/org/apache/flink/configuration/AkkaOptions.java ---
@@ -42,22 +45,27 @@
public static final ConfigOption<String> WATCH_HEARTBEAT_INTERVAL =
ConfigOptions
.key("akka.watch.heartbeat.interval")
.defaultValue(ASK_TIMEOUT.defaultValue())
- .withDescription("Heartbeat interval for Akka’s DeathWatch
mechanism to detect dead TaskManagers. If" +
- " TaskManagers are wrongly marked dead because of lost
or delayed heartbeat messages, then you should" +
- " decrease this value or increase
akka.watch.heartbeat.pause. A thorough description of Akka’s DeathWatch" +
- " can be found <a
href=\"http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#failure-detector\";>here</a>.");
+ .withDescription(Description.builder()
+ .text("Heartbeat interval for Akka’s DeathWatch
mechanism to detect dead TaskManagers. If" +
--- End diff --
we could think about adding another version of `withDescription` that works
like `text`, so that you could write this as
```
withDescription(
"Heartbeat interval for Akka’s DeathWatch mechanism to detect dead
TaskManagers. If" +
..
" Akka’s DeathWatch can be found %s",
link("http://doc.akka.io/docs/akka/snapshot/scala/remoting.html#failure-detector";,
"here"));
```
Just a thought.
> Use Description class for ConfigOptions with rich formatting
> ------------------------------------------------------------
>
> Key: FLINK-9871
> URL: https://issues.apache.org/jira/browse/FLINK-9871
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.6.0
> Reporter: Dawid Wysakowicz
> Assignee: Dawid Wysakowicz
> Priority: Major
> Labels: pull-request-available
> Fix For: 1.6.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
