[calcite] branch main updated: [MINOR][JAVADOC] Add default catalog link to test fixtures

[asolimando]

This is an automated email from the ASF dual-hosted git repository.

asolimando pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite.git


The following commit(s) were added to refs/heads/main by this push:
     new 5d771d8c6d [MINOR][JAVADOC] Add default catalog link to test fixtures
5d771d8c6d is described below

commit 5d771d8c6d706fda2f6a36332717c64adc657f38
Author: xiejiajun <jiajunbernou...@foxmail.com>
AuthorDate: Sat Oct 22 14:19:01 2022 +0800

    [MINOR][JAVADOC] Add default catalog link to test fixtures
---
 testkit/src/main/java/org/apache/calcite/test/RelOptTestBase.java    | 5 ++++-
 testkit/src/main/java/org/apache/calcite/test/SqlToRelTestBase.java  | 5 ++++-
 .../src/main/java/org/apache/calcite/test/SqlValidatorTestCase.java  | 5 ++++-
 3 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/testkit/src/main/java/org/apache/calcite/test/RelOptTestBase.java 
b/testkit/src/main/java/org/apache/calcite/test/RelOptTestBase.java
index 13d8cca98d..0a0ac79b9d 100644
--- a/testkit/src/main/java/org/apache/calcite/test/RelOptTestBase.java
+++ b/testkit/src/main/java/org/apache/calcite/test/RelOptTestBase.java
@@ -34,7 +34,10 @@ abstract class RelOptTestBase {
     return RelOptFixture.DEFAULT;
   }
 
-  /** Creates a fixture and sets its SQL statement. */
+  /**
+   * Creates a test context with a SQL query.
+   * Default catalog: {@link 
org.apache.calcite.test.catalog.MockCatalogReaderSimple#init()}.
+   */
   protected final RelOptFixture sql(String sql) {
     return fixture().sql(sql);
   }
diff --git 
a/testkit/src/main/java/org/apache/calcite/test/SqlToRelTestBase.java 
b/testkit/src/main/java/org/apache/calcite/test/SqlToRelTestBase.java
index 2a5a83444f..4b86d4656d 100644
--- a/testkit/src/main/java/org/apache/calcite/test/SqlToRelTestBase.java
+++ b/testkit/src/main/java/org/apache/calcite/test/SqlToRelTestBase.java
@@ -55,7 +55,10 @@ public abstract class SqlToRelTestBase {
     return SqlToRelFixture.DEFAULT;
   }
 
-  /** Sets the SQL statement for a test. */
+  /**
+   * Creates a test context with a SQL query.
+   * Default catalog: {@link 
org.apache.calcite.test.catalog.MockCatalogReaderSimple#init()}.
+   */
   public final SqlToRelFixture sql(String sql) {
     return fixture().expression(false).withSql(sql);
   }
diff --git 
a/testkit/src/main/java/org/apache/calcite/test/SqlValidatorTestCase.java 
b/testkit/src/main/java/org/apache/calcite/test/SqlValidatorTestCase.java
index 1b7fb1eac0..3344090cc4 100644
--- a/testkit/src/main/java/org/apache/calcite/test/SqlValidatorTestCase.java
+++ b/testkit/src/main/java/org/apache/calcite/test/SqlValidatorTestCase.java
@@ -49,7 +49,10 @@ public class SqlValidatorTestCase {
     return FIXTURE;
   }
 
-  /** Creates a test context with a SQL query. */
+  /**
+   * Creates a test context with a SQL query.
+   * Default catalog: {@link 
org.apache.calcite.test.catalog.MockCatalogReaderSimple#init()}.
+   */
   public final SqlValidatorFixture sql(String sql) {
     return fixture().withSql(sql);
   }