[GitHub] flink pull request #3495: [FLINK-5781][config] Generation HTML from ConfigOp...

[zentol <gi...@git.apache.org>]

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

    https://github.com/apache/flink/pull/3495#discussion_r115264951
  
    --- Diff: flink-core/src/test/java/org/apache/flink/configuration/ConfigOptionsDocGeneratorTest.java ---
    @@ -0,0 +1,69 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one
    + * or more contributor license agreements.  See the NOTICE file
    + * distributed with this work for additional information
    + * regarding copyright ownership.  The ASF licenses this file
    + * to you under the Apache License, Version 2.0 (the
    + * "License"); you may not use this file except in compliance
    + * with the License.  You may obtain a copy of the License at
    + *
    + *     http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * Unless required by applicable law or agreed to in writing, software
    + * distributed under the License is distributed on an "AS IS" BASIS,
    + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    + * See the License for the specific language governing permissions and
    + * limitations under the License.
    + */
    +package org.apache.flink.configuration;
    +
    +import org.junit.Test;
    +
    +import static org.junit.Assert.*;
    +
    +public class ConfigOptionsDocGeneratorTest {
    +
    +	public static class TestConfigGroup {
    +		public static ConfigOption<Integer> firstOption = ConfigOptions
    +			.key("first.option.a")
    +			.defaultValue(2)
    +			.withDescription("This is example description for the first option.");
    +
    +		public static ConfigOption<String> secondOption = ConfigOptions
    +			.key("second.option.a")
    +			.noDefaultValue()
    +			.withDescription("This is long example description for the second option.");
    +
    +		private TestConfigGroup() {
    +		}
    +	}
    +
    +	@Test
    +	public void testCreatingDescription() throws Exception {
    +		final String expectedTable = "<table class=\"table table-bordered\">" +
    +			"<thead>" +
    +			"<tr>" +
    +			"<th class=\"text-left\" style=\"width: 20%\">Name</th>" +
    --- End diff --
    
    This column probably should be named "key".


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---