From 711828beddcbeb17c1d317cb9d2c28fd7d8db0d9 Mon Sep 17 00:00:00 2001 From: Yassir Ramdani Date: Thu, 9 Jan 2025 02:02:15 +0100 Subject: [PATCH] test(isthmus): add docstring to CollationRelWriter - pr suggestion --- .../src/test/java/io/substrait/isthmus/ComplexSortTest.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/isthmus/src/test/java/io/substrait/isthmus/ComplexSortTest.java b/isthmus/src/test/java/io/substrait/isthmus/ComplexSortTest.java index 1e0ca58a..4972fce5 100644 --- a/isthmus/src/test/java/io/substrait/isthmus/ComplexSortTest.java +++ b/isthmus/src/test/java/io/substrait/isthmus/ComplexSortTest.java @@ -10,6 +10,7 @@ import java.io.PrintWriter; import java.io.StringWriter; import java.util.List; +import org.apache.calcite.rel.RelCollation; import org.apache.calcite.rel.RelNode; import org.apache.calcite.rel.externalize.RelWriterImpl; import org.apache.calcite.sql.SqlExplainLevel; @@ -25,6 +26,10 @@ public class ComplexSortTest extends PlanTestBase { final SubstraitToCalcite substraitToCalcite = new SubstraitToCalcite(EXTENSION_COLLECTION, typeFactory); + /** + * A {@link RelWriterImpl} that annotates each {@link RelNode} with its {@link RelCollation} trait + * information. A {@link RelNode} is only annotated if its {@link RelCollation} is not empty. + */ public static class CollationRelWriter extends RelWriterImpl { public CollationRelWriter(StringWriter sw) { super(new PrintWriter(sw), SqlExplainLevel.EXPPLAN_ATTRIBUTES, false);