dawidwys commented on a change in pull request #6294: [FLINK-9013][docs] Document yarn.containers.vcores only being effective whe… URL: https://github.com/apache/flink/pull/6294#discussion_r209925707
########## File path: flink-yarn/src/main/java/org/apache/flink/yarn/configuration/YarnConfigOptions.java ########## @@ -63,9 +65,14 @@ */ public static final ConfigOption<Integer> VCORES = key("yarn.containers.vcores") - .defaultValue(-1) - .withDescription("The number of virtual cores (vcores) per YARN container. By default, the number of vcores" + - " is set to the number of slots per TaskManager, if set, or to 1, otherwise."); + .defaultValue(-1) + .withDescription(Description.builder().text( + "The number of virtual cores (vcores) per YARN container. By default, the number of vcores" + + " is set to the number of slots per TaskManager, if set, or to 1, otherwise. In order for this" + + " parameter to be used your cluster must have CPU scheduling enabled. You can do this by setting" + + " the %s.", + code("org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.FairScheduler")) Review comment: @GJL thanks for your comments.The original reason for introducing the DescriptionBuilder was not to embed html or markdown into the description so that we can format it differently in case we want to print it in Exception description. ---------------------------------------------------------------- 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: us...@infra.apache.org With regards, Apache Git Services