[ 
https://issues.apache.org/jira/browse/FLINK-9792?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16538720#comment-16538720
 ] 

Chesnay Schepler commented on FLINK-9792:
-----------------------------------------

The existing tags are in there because they were ported rather lazily (mostly 
by me).

In many places is check that certain options are configured, and sanity check 
the value. The error messages in both cases is custom.
In the first case we virtually never say what that option is for and rely on 
users to figure it out, in the latter we often mention restrictions that may 
not be properly documented.
In both cases it would be more user-friendly to provide a longer error message 
right away that includes all information that the user requires.

> 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)

Reply via email to