raminqaf commented on code in PR #29864:
URL: https://github.com/apache/flink/pull/29864#discussion_r4597201673


##########
docs/data/functions/regular-expressions/regexp_instr.yml:
##########
@@ -0,0 +1,92 @@
+# 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
+
+name: REGEXP_INSTR
+summary: Returns the position of the first match of a Java regular expression 
in a string.
+
+syntax:
+  sql: REGEXP_INSTR(str, regex)
+  java: $("str").regexpInstr(regex)
+  python: col("str").regexp_instr(regex)
+
+arguments:
+  - name: str
+    type: CHAR, VARCHAR, STRING
+    required: true
+    description: The string to search.
+  - name: regex
+    type: CHAR, VARCHAR, STRING
+    required: true
+    description: A Java regular expression.
+
+returns:
+  description: The position in `str` where the first match of `regex` starts, 
counting from 1. `0` if `regex` doesn't match.
+  nulls: Returns NULL if any argument is NULL or if `regex` doesn't compile.
+  type: "`INT`, nullable."
+
+notes:
+  - Positions count UTF-16 code units, so a character outside the Basic 
Multilingual Plane, such as an emoji, counts as 2. `POSITION` counts it as 1.

Review Comment:
   I am not the biggest fan of adding the tickets to the docs page. I think 
syncing these two would be hard. Adding a bug ticket will not add it to the 
docs and (maybe) after fixing the ticket they forget to update the 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]

Reply via email to