Copilot commented on code in PR #2057: URL: https://github.com/apache/auron/pull/2057#discussion_r2876394645
########## auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronFunction.java: ########## @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.auron.flink.runtime.operator; + +/** + * Flink function which supports Auron should implement this interface. + */ +public interface FlinkAuronFunction extends SupportsAuronNative {} Review Comment: This marker interface is declared on a single line with inline braces. In this codebase interfaces are typically formatted with braces on separate lines (e.g., auron-core/src/main/java/org/apache/auron/jni/AuronAdaptorProvider.java:19-21), so please expand this to the standard multiline form for consistency. ```suggestion public interface FlinkAuronFunction extends SupportsAuronNative { } ``` ########## auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronFunction.java: ########## @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.auron.flink.runtime.operator; + +/** + * Flink function which supports Auron should implement this interface. Review Comment: The Javadoc sentence is awkward (“Flink function which supports…”). Please adjust the wording (e.g., “Flink functions that support Auron should implement this interface.”) to improve readability in generated docs. ```suggestion * Flink functions that support Auron should implement this interface. ``` ########## auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronOperator.java: ########## @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.auron.flink.runtime.operator; + +/** + * Flink operator which supports Auron should implement this interface. Review Comment: The Javadoc sentence is awkward (“Flink operator which supports…”). Please adjust the wording (e.g., “Flink operators that support Auron should implement this interface.”) to improve readability in generated docs. ```suggestion * Flink operators that support Auron should implement this interface. ``` ########## auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/SupportsAuronNative.java: ########## @@ -0,0 +1,48 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.auron.flink.runtime.operator; + +import java.util.List; +import org.apache.auron.metric.MetricNode; +import org.apache.auron.protobuf.PhysicalPlanNode; +import org.apache.flink.table.types.logical.RowType; + +/** + * Support native Auron interface. Review Comment: The Javadoc summary is grammatically incorrect/ambiguous (“Support native Auron interface.”). Please rephrase to something like “Supports Auron native interface.” so the subject matches the type name and reads clearly in generated docs. ```suggestion * Supports Auron native interface. ``` ########## auron-flink-extension/auron-flink-runtime/src/main/java/org/apache/auron/flink/runtime/operator/FlinkAuronOperator.java: ########## @@ -0,0 +1,22 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.auron.flink.runtime.operator; + +/** + * Flink operator which supports Auron should implement this interface. + */ +public interface FlinkAuronOperator extends SupportsAuronNative {} Review Comment: This marker interface is declared on a single line with inline braces. In this codebase interfaces are typically formatted with braces on separate lines (e.g., auron-core/src/main/java/org/apache/auron/jni/AuronAdaptorProvider.java:19-21), so please expand this to the standard multiline form for consistency. ```suggestion public interface FlinkAuronOperator extends SupportsAuronNative { } ``` -- 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]
