Merge pull request #306 from FalkorDB/flex-udf-param-tables

swilly22 · web-flow · commit c9fb60da7159 · 2025-12-31T14:49:37.000+02:00
Fix FLEX function parameter tables
diff --git a/udfs/flex/bitwise/and.md b/udfs/flex/bitwise/and.md
@@ -16,6 +16,7 @@ flex.bitwise.and(a, b)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | First operand |
diff --git a/udfs/flex/bitwise/not.md b/udfs/flex/bitwise/not.md
@@ -16,6 +16,7 @@ flex.bitwise.not(a)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | The operand to invert |
diff --git a/udfs/flex/bitwise/or.md b/udfs/flex/bitwise/or.md
@@ -16,6 +16,7 @@ flex.bitwise.or(a, b)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | First operand |
diff --git a/udfs/flex/bitwise/shiftLeft.md b/udfs/flex/bitwise/shiftLeft.md
@@ -16,6 +16,7 @@ flex.bitwise.shiftLeft(a, positions)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | The value to shift |
diff --git a/udfs/flex/bitwise/shiftRight.md b/udfs/flex/bitwise/shiftRight.md
@@ -16,6 +16,7 @@ flex.bitwise.shiftRight(a, positions)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | The value to shift |
diff --git a/udfs/flex/bitwise/xor.md b/udfs/flex/bitwise/xor.md
@@ -16,6 +16,7 @@ flex.bitwise.xor(a, b)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `a` | number (integer) | Yes | First operand |
diff --git a/udfs/flex/collections/frequencies.md b/udfs/flex/collections/frequencies.md
@@ -16,6 +16,7 @@ flex.coll.frequencies(list)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list` | list | Yes | The list to analyze |
diff --git a/udfs/flex/collections/intersection.md b/udfs/flex/collections/intersection.md
@@ -16,6 +16,7 @@ flex.coll.intersection(list1, list2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list1` | list | Yes | The first list |
diff --git a/udfs/flex/collections/shuffle.md b/udfs/flex/collections/shuffle.md
@@ -16,6 +16,7 @@ flex.coll.shuffle(list)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list` | list | Yes | The list to shuffle |
diff --git a/udfs/flex/collections/union.md b/udfs/flex/collections/union.md
@@ -16,6 +16,7 @@ flex.coll.union(list1, list2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list1` | list | Yes | The first list |
diff --git a/udfs/flex/collections/zip.md b/udfs/flex/collections/zip.md
@@ -16,6 +16,7 @@ flex.coll.zip(list1, list2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list1` | list | Yes | The first list |
diff --git a/udfs/flex/date/format.md b/udfs/flex/date/format.md
@@ -16,6 +16,7 @@ flex.date.format(datetime, pattern, timezone)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `datetime` | Date/number/string | Yes | The date/time value to format |
diff --git a/udfs/flex/date/parse.md b/udfs/flex/date/parse.md
@@ -16,6 +16,7 @@ flex.date.parse(dateString, pattern, timezone)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `dateString` | string | Yes | The date/time string to parse |
diff --git a/udfs/flex/date/toTimeZone.md b/udfs/flex/date/toTimeZone.md
@@ -16,6 +16,7 @@ flex.date.toTimeZone(datetime, timezone)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `datetime` | Date/number/string | Yes | The date/time value to convert |
diff --git a/udfs/flex/date/truncate.md b/udfs/flex/date/truncate.md
@@ -16,6 +16,7 @@ flex.date.truncate(datetime, unit)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `datetime` | Date/number/string | Yes | The date/time value to truncate |
diff --git a/udfs/flex/json/fromJsonList.md b/udfs/flex/json/fromJsonList.md
@@ -16,6 +16,7 @@ flex.json.fromJsonList(jsonString)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `jsonString` | string | Yes | A JSON string representing an array |
diff --git a/udfs/flex/json/fromJsonMap.md b/udfs/flex/json/fromJsonMap.md
@@ -16,6 +16,7 @@ flex.json.fromJsonMap(jsonString)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `jsonString` | string | Yes | A JSON string representing an object |
diff --git a/udfs/flex/json/toJson.md b/udfs/flex/json/toJson.md
@@ -16,6 +16,7 @@ flex.json.toJson(value)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `value` | any | Yes | The value to serialize to JSON |
diff --git a/udfs/flex/map/fromPairs.md b/udfs/flex/map/fromPairs.md
@@ -16,6 +16,7 @@ flex.map.fromPairs(pairs)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `pairs` | list | Yes | A list of two-element arrays, each containing `[key, value]` |
diff --git a/udfs/flex/map/merge.md b/udfs/flex/map/merge.md
@@ -16,6 +16,7 @@ flex.map.merge(map1, map2, ...)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `map1` | map | No | First map to merge |
diff --git a/udfs/flex/map/removeKey.md b/udfs/flex/map/removeKey.md
@@ -16,6 +16,7 @@ flex.map.removeKey(map, key)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `map` | map | Yes | The map to remove the key from |
diff --git a/udfs/flex/map/removeKeys.md b/udfs/flex/map/removeKeys.md
@@ -16,6 +16,7 @@ flex.map.removeKeys(map, keys)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `map` | map | Yes | The map to remove keys from |
diff --git a/udfs/flex/map/submap.md b/udfs/flex/map/submap.md
@@ -16,6 +16,7 @@ flex.map.submap(map, keys)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `map` | map | Yes | The source map to extract keys from |
diff --git a/udfs/flex/similarity/jaccard.md b/udfs/flex/similarity/jaccard.md
@@ -16,6 +16,7 @@ flex.sim.jaccard(list1, list2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `list1` | list | Yes | The first list to compare |
diff --git a/udfs/flex/text/camelCase.md b/udfs/flex/text/camelCase.md
@@ -16,6 +16,7 @@ flex.text.camelCase(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to convert to camelCase |
diff --git a/udfs/flex/text/capitalize.md b/udfs/flex/text/capitalize.md
@@ -16,6 +16,7 @@ flex.text.capitalize(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to capitalize |
diff --git a/udfs/flex/text/decapitalize.md b/udfs/flex/text/decapitalize.md
@@ -16,6 +16,7 @@ flex.text.decapitalize(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to decapitalize |
diff --git a/udfs/flex/text/format.md b/udfs/flex/text/format.md
@@ -16,6 +16,7 @@ flex.text.format(template, parameters)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `template` | string | Yes | The format string containing `{0}`, `{1}`, etc. placeholders |
diff --git a/udfs/flex/text/indexOf.md b/udfs/flex/text/indexOf.md
@@ -16,6 +16,7 @@ flex.text.indexOf(string, substring, offset, to)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to search in |
diff --git a/udfs/flex/text/indexesOf.md b/udfs/flex/text/indexesOf.md
@@ -16,6 +16,7 @@ flex.text.indexesOf(string, substring, from, to)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to search in |
diff --git a/udfs/flex/text/jaroWinkler.md b/udfs/flex/text/jaroWinkler.md
@@ -16,6 +16,7 @@ flex.text.jaroWinkler(string1, string2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string1` | string | Yes | The first string to compare |
diff --git a/udfs/flex/text/join.md b/udfs/flex/text/join.md
@@ -16,6 +16,7 @@ flex.text.join(array, delimiter)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `array` | list | Yes | The array of strings to join |
diff --git a/udfs/flex/text/levenshtein.md b/udfs/flex/text/levenshtein.md
@@ -16,6 +16,7 @@ flex.text.levenshtein(string1, string2)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string1` | string | Yes | The first string to compare |
diff --git a/udfs/flex/text/lpad.md b/udfs/flex/text/lpad.md
@@ -16,6 +16,7 @@ flex.text.lpad(string, length, padChar)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string/number | Yes | The string to pad (will be converted to string if number) |
diff --git a/udfs/flex/text/regexGroups.md b/udfs/flex/text/regexGroups.md
@@ -16,6 +16,7 @@ flex.text.regexGroups(string, regex)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to search in |
diff --git a/udfs/flex/text/repeat.md b/udfs/flex/text/repeat.md
@@ -16,6 +16,7 @@ flex.text.repeat(string, count)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to repeat |
diff --git a/udfs/flex/text/replace.md b/udfs/flex/text/replace.md
@@ -16,6 +16,7 @@ flex.text.replace(string, regex, replacement)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to perform replacements on |
diff --git a/udfs/flex/text/rpad.md b/udfs/flex/text/rpad.md
@@ -16,6 +16,7 @@ flex.text.rpad(string, length, padChar)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string/number | Yes | The string to pad (will be converted to string if number) |
diff --git a/udfs/flex/text/snakeCase.md b/udfs/flex/text/snakeCase.md
@@ -16,6 +16,7 @@ flex.text.snakeCase(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to convert to snake_case |
diff --git a/udfs/flex/text/swapCase.md b/udfs/flex/text/swapCase.md
@@ -16,6 +16,7 @@ flex.text.swapCase(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to swap case |
diff --git a/udfs/flex/text/upperCamelCase.md b/udfs/flex/text/upperCamelCase.md
@@ -16,6 +16,7 @@ flex.text.upperCamelCase(string)
 ```
 
 ## Parameters
+
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `string` | string | Yes | The string to convert to UpperCamelCase |
