Skip to content

Clarify DataFrame row selection documentation - #7750

Closed
svick wants to merge 1 commit into
dotnet:mainfrom
svick:clarify-dataframe-filter-docs
Closed

svick wants to merge 1 commit into
dotnet:mainfrom
svick:clarify-dataframe-filter-docs

Conversation

@svick

@svick svick commented Oct 1, 2026

Copy link
Copy Markdown
Member

Summary

  • explain how Boolean DataFrame filters map values to rows, including shorter filters
  • document row-index ordering and repeated-index behavior for DataFrame indexers and DataFrameColumn.Clone overloads
  • clarify row-index semantics for cumulative and reduction methods and update the source template

Validation

  • dotnet build src\Microsoft.Data.Analysis\Microsoft.Data.Analysis.csproj --no-restore

Explain how Boolean filters and row-index collections select, order, and repeat rows and column values.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Some clone documentation contradicts sequence truncation and ignored append parameters.

Review effort: Balanced
Findings: 2 Medium severity

Open (2)
What changed in this PR

Clarifies DataFrame row-selection, cloning, and row-subset computation semantics.

Changes:

  • Documents Boolean and index-based row selection.
  • Clarifies ordering, repeated indices, and cumulative-operation parameters.
  • Updates generated documentation and its template.
File Description
PrimitiveDataFrameColumn.cs Documents clone overload behavior.
DataFrameColumns/​VBufferDataFrameColumn.cs Inherits clone documentation.
DataFrameColumns/​StringDataFrameColumn.cs Inherits clone documentation.
DataFrameColumns/​ArrowStringDataFrameColumn.cs Inherits clone documentation.
DataFrameColumn.cs Clarifies base clone contracts.
DataFrameColumn.Computations.tt Updates computation documentation template.
DataFrameColumn.Computations.cs Regenerates row-subset documentation.
DataFrame.cs Clarifies filtering and indexer semantics.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

return ret;
}

/// <inheritdoc cref="DataFrameColumn.Clone(DataFrameColumn, bool, long)"/>
Comment on lines +541 to +546
/// <summary>
/// Clones the column using the values in <paramref name="mapIndices"/> as zero-based indices into this column.
/// </summary>
/// <param name="mapIndices">
/// The indices of values to copy. Their enumeration order determines the result order, and repeated indices produce repeated values.
/// </param>
@svick

svick commented Oct 1, 2026

Copy link
Copy Markdown
Member Author

Closing as supeseded by #7753.

@svick svick closed this Oct 1, 2026
@svick
svick deleted the clarify-dataframe-filter-docs branch October 1, 2026 15:12
@codecov

codecov Bot commented Oct 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.89%. Comparing base (13dc9c5) to head (137e25e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7750      +/-   ##
==========================================
- Coverage   69.89%   69.89%   -0.01%     
==========================================
  Files        1487     1487              
  Lines      276323   276323              
  Branches    28295    28295              
==========================================
- Hits       193142   193133       -9     
- Misses      75694    75699       +5     
- Partials     7487     7491       +4     
Flag Coverage Δ
Debug 69.89% <ø> (-0.01%) ⬇️
production 64.07% <ø> (-0.01%) ⬇️
test 89.83% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/Microsoft.Data.Analysis/DataFrame.cs 93.93% <ø> (ø)
...soft.Data.Analysis/DataFrameColumn.Computations.cs 40.00% <ø> (ø)
src/Microsoft.Data.Analysis/DataFrameColumn.cs 65.46% <ø> (ø)
...sis/DataFrameColumns/ArrowStringDataFrameColumn.cs 59.16% <ø> (ø)
...Analysis/DataFrameColumns/StringDataFrameColumn.cs 68.15% <ø> (ø)
...nalysis/DataFrameColumns/VBufferDataFrameColumn.cs 44.57% <ø> (ø)
...icrosoft.Data.Analysis/PrimitiveDataFrameColumn.cs 72.53% <ø> (ø)

... and 6 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants