PHILO-HE commented on code in PR #10603:
URL:
https://github.com/apache/incubator-gluten/pull/10603#discussion_r2324192466
##########
gluten-core/src/main/scala/org/apache/gluten/config/ConfigBuilder.scala:
##########
@@ -51,6 +51,13 @@ private[gluten] case class ConfigBuilder(key: String) {
this
}
+ /**
+ * `internal()` method are designed to tag config item as: * internal or
experimental
+ * functionality * intended exclusively for developers or advanced users *
unstable and not
+ * exposed to external users * allowing for flexibility in development and
testing without
+ * compromising the public API's stability
+ * @return
+ */
Review Comment:
Using `*` to mark items is not friendly to readers in the comment section.
Suggested:
```
/**
* This method marks a config as internal for any of the following reasons:
* - Intended exclusively for developers or advanced users
* - Experimental or unstable, not yet exposed to end users
* - Allows for flexibility in development and testing without
* compromising the public API's stability
*/
```
--
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]
