Copilot commented on code in PR #2811: URL: https://github.com/apache/sedona/pull/2811#discussion_r3012895722
########## docs/api/sql/Geometry-Processing/ST_OffsetCurve.md: ########## @@ -0,0 +1,54 @@ +<!-- + 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. + --> + +# ST_OffsetCurve + + + +Introduction: Returns a line at a given offset distance from a linear geometry. If the distance is positive, the offset is on the left side of the input line; if it is negative, it is on the right side. Returns null for empty geometries. + +The optional third parameter `quadrantSegments` controls the number of line segments used to approximate a quarter circle at round joins. The default value is 8. + +Format: `ST_OffsetCurve(geometry: Geometry, distance: Double, quadrantSegments: Integer)` + +Format: `ST_OffsetCurve(geometry: Geometry, distance: Double)` Review Comment: The SQL docs format here differs from other SQL geometry-processing pages: overloads are usually documented via a single optional-parameter signature (e.g., `ST_MinimumBoundingCircle`) or via a `Format:` section with code blocks (e.g., `ST_Buffer`), and SQL results are typically shown in a fenced `Output:` block. Consider consolidating the two `Format:` lines into a single optional-signature format and switching the inline `Output: `...`` to the standard fenced output blocks for consistency/readability. ########## docs/api/flink/Geometry-Processing/ST_OffsetCurve.md: ########## @@ -0,0 +1,52 @@ +<!-- + 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. + --> + +# ST_OffsetCurve + +Introduction: Returns a line at a given offset distance from a linear geometry. If the distance is positive, the offset is on the left side of the input line; if it is negative, it is on the right side. Returns null for empty geometries. + +The optional third parameter `quadrantSegments` controls the number of line segments used to approximate a quarter circle at round joins. The default value is 8. + +Format: `ST_OffsetCurve(geometry: Geometry, distance: Double, quadrantSegments: Integer)` + +Format: `ST_OffsetCurve(geometry: Geometry, distance: Double)` + +Return type: `Geometry` Review Comment: Other Flink geometry-processing docs typically document overloads as a single signature with an optional parameter and show results under an `Output:` fenced block (e.g., `ST_OrientedEnvelope`). Here the overloads are split across two `Format:` lines and the outputs are inline. Consider consolidating the signature (e.g., `[Optional] quadrantSegments`) and using fenced output blocks to match the rest of the Flink docs. -- 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]
