paulk-asert commented on a change in pull request #1574: URL: https://github.com/apache/groovy/pull/1574#discussion_r624982927
########## File path: subprojects/groovy-toml/src/test/groovy/groovy/toml/TomlJavadocAssertionTest.groovy ########## @@ -0,0 +1,28 @@ +/* + * 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 groovy.toml + +import groovy.test.JavadocAssertionTestSuite +import org.junit.runner.RunWith +import org.junit.runners.Suite + +@RunWith(Suite) +@Suite.SuiteClasses(JavadocAssertionTestSuite) +class TomlJavadocAssertionTest { Review comment: I'd remove if we don't enhance the documentation with such tests. I'd prefer to enhance the doco since not everyone reads the asciidoc doc, e.g. one or two examples like this one from `YamlBuilder`: ``` /** * Named arguments can be passed to the YAML builder instance to create a root YAML object * <p> * Example: * <pre><code class="groovyTestCase"> * def yaml = new groovy.yaml.YamlBuilder() * yaml name: "Guillaume", age: 33 * * assert yaml.toString() == '''--- * name: "Guillaume" * age: 33 * ''' * </code></pre> * * @param m a map of key / value pairs * @return a map of key / value pairs */ public Object call(Map m) { return jsonBuilder.call(m); } ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
