Improve categorize javadocs

jan-elastic · jan-elastic · commit 35e98113956e · 2024-12-09T15:22:22.000+01:00
diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Categorize.java
@@ -95,7 +95,8 @@ public boolean foldable() {
 
     @Override
     public Nullability nullable() {
-        // Both nulls and empty strings result in null values
+        // Null strings and strings that don't produce tokens after analysis lead to null values.
+        // This includes empty strings, only whitespace, (hexa)decimal numbers and stopwords.
         return Nullability.TRUE;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,8 @@ public boolean foldable() {`
`95`	`95`
`96`	`96`	`@Override`
`97`	`97`	`public Nullability nullable() {`
`98`		`- // Both nulls and empty strings result in null values`
	`98`	`+ // Null strings and strings that don't produce tokens after analysis lead to null values.`
	`99`	`+ // This includes empty strings, only whitespace, (hexa)decimal numbers and stopwords.`
`99`	`100`	`return Nullability.TRUE;`
`100`	`101`	`}`
`101`	`102`