cloud-fan commented on code in PR #56486:
URL: https://github.com/apache/spark/pull/56486#discussion_r3510920610


##########
sql/catalyst/src/main/java/org/apache/spark/sql/connector/read/SupportsPushDownJoin.java:
##########
@@ -52,7 +52,11 @@ public interface SupportsPushDownJoin extends ScanBuilder {
    * @param rightSideRequiredColumnsWithAliases required output of the
    *                                            right side {@code 
SupportsPushDownJoin}
    * @param condition join condition. Columns are named after the specified 
aliases in
-   * {@code leftSideRequiredColumnWithAliases} and {@code 
rightSideRequiredColumnWithAliases}
+   * {@code leftSideRequiredColumnsWithAliases} and {@code 
rightSideRequiredColumnsWithAliases}
+   * <p>
+   * If this scan builder holds previously pushed state, such as a pushed 
table sample, and cannot

Review Comment:
   This method-level contract sentence sits inside the `@param condition` block 
(after the condition text, before `@return`), so JavaDoc renders it as part of 
the `condition` parameter's description rather than as guidance about the 
method's return contract. Moving it to a standalone paragraph in the method 
description (or after `@return`) makes it read as the method-level contract it 
is.



-- 
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.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to