You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by xi...@apache.org on 2025/05/07 09:17:00 UTC

(calcite) branch main updated: Update documentation for example0 in RelBuilderExample

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

xiong 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 19ce56761e Update documentation for example0 in RelBuilderExample
19ce56761e is described below

commit 19ce56761e0b377f2b3e1d7286bcde969ed8e8db
Author: sulees <es...@gmail.com>
AuthorDate: Sat May 3 16:17:29 2025 +0300

    Update documentation for example0 in RelBuilderExample
    
    This corrects the comment for `example0` to accurately describe the code's behavior.
    
    **Problem**:
    The original comment incorrectly stated that the code performs a table scan (`SELECT * FROM emp`). However, the code uses the `VALUES` clause to create an inline table of literal values.
    
    **Fix**:
    The comment has been updated to reflect the actual behavior, which is equivalent to:
    `VALUES (1, TRUE), (NULL, FALSE)`.
    
    **Impact**:
    Developers referencing this example will now see documentation that aligns with the code’s functionality.
    
    Thank you for considering this improvement! 🙏
    
    Update RelBuilderExample.java
    
    i changed the format, thanks
---
 .../src/test/java/org/apache/calcite/examples/RelBuilderExample.java | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/core/src/test/java/org/apache/calcite/examples/RelBuilderExample.java b/core/src/test/java/org/apache/calcite/examples/RelBuilderExample.java
index b3c6a6675f..c576dffc0f 100644
--- a/core/src/test/java/org/apache/calcite/examples/RelBuilderExample.java
+++ b/core/src/test/java/org/apache/calcite/examples/RelBuilderExample.java
@@ -71,11 +71,10 @@ private RelBuilder doExample(RelBuilder builder, int i) {
   }
 
   /**
-   * Creates a relational expression for a table scan.
+   * Creates a relational expression for a values.
    * It is equivalent to
    *
-   * <blockquote><pre>SELECT *
-   * FROM emp</pre></blockquote>
+   * <blockquote><pre>VALUES((1, TRUE), (NULL, FALSE))</pre></blockquote>
    */
   private RelBuilder example0(RelBuilder builder) {
     return builder