[
https://issues.apache.org/jira/browse/FLINK-9792?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16538708#comment-16538708
]
Dawid Wysakowicz commented on FLINK-9792:
-----------------------------------------
Hmm, right know the only place where `description` is used is the online
documentation. I am also not sure if at any point it will make sense to return
such a long descriptions in any error messages. Moreover there are already
multiple options that have a html tag in the description, which simply does not
work. I also think it might make sense to add possibility to add further format
description that is displayed e.g. bulleted lists etc. not only links.
I thought about adding possibility to escape "<" and ">", which constitute a
html tag. It could work like:
{code:java}
static class TestConfigGroupWithHtmlTagsInDescription {
public static ConfigOption<Integer> firstOption = ConfigOptions
.key("first.option.a")
.defaultValue(2)
.withDescription("This is example description for the first option. \\<a
href=\"http://link\"\\>here\\</a\\>");
}{code}
What do you think [~Zentol]?
> Cannot add html tags in options description
> -------------------------------------------
>
> Key: FLINK-9792
> URL: https://issues.apache.org/jira/browse/FLINK-9792
> Project: Flink
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.5.1, 1.6.0
> Reporter: Dawid Wysakowicz
> Assignee: Dawid Wysakowicz
> Priority: Major
>
> Right now it is impossible to add any html tags in options description,
> because all "<" and ">" are escaped. Therefore some links there do not work.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
