[
https://issues.apache.org/jira/browse/FLINK-9792?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16540410#comment-16540410
]
ASF GitHub Bot commented on FLINK-9792:
---------------------------------------
GitHub user dawidwys opened a pull request:
https://github.com/apache/flink/pull/6312
[FLINK-9792] Added custom Description class for ConfigOptions to enable
rich formatting.
## What is the purpose of the change
Enable rich formatting of options description.
## Brief change log
*(for example:)*
- Implemented Description class that represents description with
formatting.
- added html formatter that transforms Description to Html string
## Verifying this change
This change added tests and can be verified as follows:
- DescriptionHtmlTest
- all tests for generating documentation still works
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (yes / **no**)
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: (yes / **no**)
- The serializers: (yes / **no** / don't know)
- The runtime per-record code paths (performance sensitive): (yes /
**no** / don't know)
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / **no** / don't know)
- The S3 file system connector: (yes / **no** / don't know)
## Documentation
- Does this pull request introduce a new feature? (yes / **no**)
- If yes, how is the feature documented? (not applicable / docs /
**JavaDocs** / not documented)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dawidwys/flink FLINK-9792
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/6312.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 #6312
----
commit 96a19555539fcb24122bb4f5efb346dc8fa30db9
Author: Dawid Wysakowicz <dwysakowicz@...>
Date: 2018-07-11T07:52:48Z
[FLINK-9792] Added custom Description class for ConfigOptions to enable
rich formatting.
----
> 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
> Labels: pull-request-available
>
> 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)
