Skip to content

Conversation

@shahar-biron
Copy link
Contributor

@shahar-biron shahar-biron commented Dec 31, 2025

Ensure there is a blank line between each '## Parameters' heading and the following Markdown table so parameter definitions render correctly in FLEX function docs.

Co-Authored-By: Warp [email protected]

PR Summary by Typo

Overview

This PR addresses a minor formatting issue in the documentation for various FLEX functions by adding a blank line before the "Parameters" section.

Key Changes

  • Added a blank line before the ## Parameters heading in 41 documentation files for FLEX User-Defined Functions (UDFs). This improves the visual separation and readability of the parameter tables.

Work Breakdown

Category Lines Changed
New Work 41 (100%)
Total Changes 41
To turn off PR summary, please visit Notification settings.

Summary by CodeRabbit

  • Documentation
    • Improved formatting consistency across function documentation with enhanced parameter table structure
    • Updated parameter documentation for multiple functions to accurately reflect their signatures and inputs
    • Added clarification of previously undocumented parameters in text manipulation, date, collection, and map functions

✏️ Tip: You can customize this high-level summary in your review settings.

Ensure there is a blank line between each '## Parameters' heading and the following Markdown table so parameter definitions render as tables instead of inline text.

Co-Authored-By: Warp <[email protected]>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 31, 2025

📝 Walkthrough

Walkthrough

This PR standardizes documentation formatting across 40+ FLEX UDF modules by adding blank lines after section headings and introducing missing parameter table headers. Additionally, several files receive new or expanded parameter documentation to complete their function signatures.

Changes

Cohort / File(s) Summary
Bitwise operations formatting
udfs/flex/bitwise/and.md, udfs/flex/bitwise/not.md, udfs/flex/bitwise/xor.md, udfs/flex/bitwise/shiftRight.md
Add blank lines after "## Parameters" headers and table headers for consistent documentation formatting
Bitwise operations with parameter updates
udfs/flex/bitwise/or.md, udfs/flex/bitwise/shiftLeft.md
Add blank lines and/or introduce Parameters table headers; shiftLeft expands to document the "positions" parameter
Collections documentation
udfs/flex/collections/frequencies.md, udfs/flex/collections/shuffle.md, udfs/flex/collections/union.md, udfs/flex/collections/zip.md
Add blank lines and/or Parameters table headers for formatting standardization
Collections with parameter expansion
udfs/flex/collections/intersection.md
Introduce list2 parameter and table header to document both list1 and list2 inputs
Date operations formatting
udfs/flex/date/format.md, udfs/flex/date/parse.md, udfs/flex/date/toTimeZone.md
Add blank lines after "## Parameters" headers
Date operations with signature update
udfs/flex/date/truncate.md
Add new required parameter "unit" (string), changing function signature from flex.date.truncate(datetime) to flex.date.truncate(datetime, unit)
JSON utilities formatting
udfs/flex/json/fromJsonList.md, udfs/flex/json/fromJsonMap.md, udfs/flex/json/toJson.md
Add blank lines after "## Parameters" headers for consistent spacing
Map operations formatting
udfs/flex/map/fromPairs.md, udfs/flex/map/removeKey.md, udfs/flex/map/submap.md
Add blank lines after "## Parameters" headers
Map operations with parameter updates
udfs/flex/map/removeKeys.md
Add new "keys" parameter (list, required) documenting array of key names to remove
Map operations with table expansion
udfs/flex/map/merge.md
Expand Parameters table with header row and additional entries for map2 and variadic inputs
Similarity operations
udfs/flex/similarity/jaccard.md
Expand Parameters table to document both list1 and list2 as required inputs
Text operations formatting
udfs/flex/text/capitalize.md, udfs/flex/text/format.md, udfs/flex/text/jaroWinkler.md, udfs/flex/text/replace.md, udfs/flex/text/rpad.md, udfs/flex/text/snakeCase.md, udfs/flex/text/upperCamelCase.md
Add blank lines after "## Parameters" headers
Text operations with parameter additions
udfs/flex/text/camelCase.md, udfs/flex/text/decapitalize.md, udfs/flex/text/indexOf.md, udfs/flex/text/indexesOf.md
Add blank lines and/or expand parameter table documentation; indexOf adds substring, offset, and to parameters
Text operations with new parameters
udfs/flex/text/join.md
Add delimiter parameter (string, required) to Parameters table
Text operations with expanded documentation
udfs/flex/text/levenshtein.md
Add second parameter string2 to reflect two-argument function signature
Text operations with significant parameter expansion
udfs/flex/text/lpad.md
Expand from single parameter to include length (number, required) and padChar (string, optional with space default)
Text operations with regex parameter
udfs/flex/text/regexGroups.md
Add new regex parameter (string, required) documenting the regular expression pattern
Text operations with repeat parameter
udfs/flex/text/repeat.md
Add count parameter to Parameters table with type and description
Text operations with case operations
udfs/flex/text/swapCase.md
Introduce Parameters table with header row documenting the string parameter

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • Fix FLEX UDF docs navigation #304: Modifies the same set of FLEX UDF documentation files across multiple modules, indicating coordinated documentation standardization effort.

Suggested labels

Manual Review Time 30-60 min

Suggested reviewers

  • swilly22

Poem

🐰 Documentation hops in spring!
Blank lines dance where parameters sing,
Tables now complete and bright,
Function signatures set right!
✨📚

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix FLEX function parameter tables' directly and clearly summarizes the main change: fixing parameter table formatting across FLEX function documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@typo-app
Copy link
Contributor

typo-app bot commented Dec 31, 2025

Static Code Review 📊

✅ All quality checks passed!

@swilly22 swilly22 merged commit c9fb60d into main Dec 31, 2025
4 of 5 checks passed
@swilly22 swilly22 deleted the flex-udf-param-tables branch December 31, 2025 12:49
Copy link
Contributor

@typo-app typo-app bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Code Review 🤖

Files Reviewed: 41
Comments Added: 0
Lines of Code Analyzed: 41
Critical Issues: 0

PR Health: Good

Give 👍 or 👎 on each review comment to help us improve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants