[GitHub] flink pull request #3495: [FLINK-5781] Generation HTML from ConfigOption

[clarkyzl]

Github user clarkyzl commented on a diff in the pull request:

https://github.com/apache/flink/pull/3495#discussion_r105077753
  
--- Diff: 
flink-core/src/main/java/org/apache/flink/configuration/ConfigOption.java ---
@@ -137,6 +153,26 @@ public boolean hasDeprecatedKeys() {
return deprecatedKeys == EMPTY ? 
Collections.emptyList() : Arrays.asList(deprecatedKeys);
}
 
+   public String shortDescription() {
+   return shortDescription;
+   }
+
+   public String description() {
+   return description;
+   }
+
+   String toHTMLString(boolean includeShort) {
+   String stringBuilder = "" +
--- End diff --

I think we should use `java.lang.StringBuilder`.

```java
StringBuilder sb = new StringBuilder();
sb.append("")
.append("").append(key).append("");
```


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] flink pull request #3495: [FLINK-5781] Generation HTML from ConfigOption

[dawidwys]

GitHub user dawidwys opened a pull request:

https://github.com/apache/flink/pull/3495

[FLINK-5781] Generation HTML from ConfigOption

Thanks for contributing to Apache Flink. Before you open your pull request, 
please take the following check list into consideration.
If your changes take all of the items into account, feel free to open your 
pull request. For more information and/or questions please refer to the [How To 
Contribute guide](http://flink.apache.org/how-to-contribute.html).
In addition to going through the list, please provide a meaningful 
description of your changes.

- [ ] General
  - The pull request references the related JIRA issue ("[FLINK-XXX] Jira 
title text")
  - The pull request addresses only one issue
  - Each commit in the PR has a meaningful commit message (including the 
JIRA id)

- [ ] Documentation
  - Documentation has been added for new functionality
  - Old documentation affected by the pull request has been updated
  - JavaDoc for public methods has been added

- [ ] Tests & Build
  - Functionality added by the pull request is covered by tests
  - `mvn clean verify` has been executed successfully locally or a Travis 
build has passed


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/dawidwys/flink configHTML

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/3495.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 #3495


commit 303e9dd06f895d8df33cb8b6494cd622a2dafaba
Author: Dawid Wysakowicz 
Date:   2017-03-08T14:57:33Z

[FLINK-5781] Generation HTML from ConfigOption




---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---