You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by dawidwys <gi...@git.apache.org> on 2018/07/19 09:58:36 UTC
[GitHub] flink pull request #6371: [FLINK-9871] Use Description class for ConfigOptio...
GitHub user dawidwys opened a pull request:
https://github.com/apache/flink/pull/6371
[FLINK-9871] Use Description class for ConfigOptions with rich format…
Updated `ConfigOptions` which had links to use `Description` class, which properly handles rich formatting.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dawidwys/flink FLINK-9871
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/6371.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #6371
----
commit c829ef55c5fca16ccb537daa77f035efd0ee45c6
Author: Dawid Wysakowicz <dw...@...>
Date: 2018-07-17T09:25:42Z
[FLINK-9871] Use Description class for ConfigOptions with rich formatting
----
---
[GitHub] flink pull request #6371: [FLINK-9871] Use Description class for ConfigOptio...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/6371
---
[GitHub] flink pull request #6371: [FLINK-9871] Use Description class for ConfigOptio...
Posted by zentol <gi...@git.apache.org>.
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.
---