docs: concatenate and merge options for dataframe operations component#12819
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughDocumentation additions describing two new Table Operations: Concatenate for vertically stacking multiple Table inputs, and Merge for combining two Table objects by matching on a shared column. Changes applied to both current and versioned documentation files. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 8 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (8 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/Components/dataframe-operations.mdx`:
- Around line 157-160: Update the documentation text to clarify that
merge_on_column is optional (when empty the implementation falls back to an
index-based merge) and that merge_how controls retention of unmatched rows (use
inner for only matches, left/right to retain unmatched rows from the specified
side, and outer to retain unmatched rows from both); reference the merge
parameters merge_on_column and merge_how and mirror the actual behavior
implemented in dataframe_operations.py (the merge routine handling index-based
merges and left/right/outer semantics).
In `@docs/versioned_docs/version-1.9.0/Components/dataframe-operations.mdx`:
- Around line 157-160: The documentation incorrectly states merge only happens
on columns and that output contains only matched rows; update the wording for
merge_on_column and merge_how to describe that leaving merge_on_column empty
triggers an index-based merge and that merge_how governs whether unmatched rows
are retained (inner = only matched rows; left/right = keep all rows from
respective side including unmatched; outer = keep all rows from both sides), and
clarify the function/class that returns a Table with rows from both inputs
according to these rules (refer to merge_on_column and merge_how and the
dataframe_operations implementation that handles index-based merging).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d39df159-81f5-4b70-b490-7859f675f139
📒 Files selected for processing (2)
docs/docs/Components/dataframe-operations.mdxdocs/versioned_docs/version-1.9.0/Components/dataframe-operations.mdx
This comment has been minimized.
This comment has been minimized.
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
|
Build successful! ✅ |
Add the Concatenate and Merge options to the Table Operations component.
#11601
Summary by CodeRabbit