Skip to content

GH-46396: [C++][Documentation][Statistics] Revise the documentation to clarify that arrow::ArrayStatistics is ignored during arrow::Array comparisons #46470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

andishgar
Copy link
Contributor

@andishgar andishgar commented May 16, 2025

Rationale for this change

as mentiond here, The document should be clarified that arrow::ArrayStatistics is not inlcuded in the arrow::Array comparasion

What changes are included in this PR?

Add documets for arrow::Array::Equals, arrow::Array::ApproxEquals, arrow::Array::EqualsRange, arrow::ArrayEquals, arrow::ArrayApproxEquals, arrow::ArrayRangeEquals, and arrow::ArrayRangeApproxEquals

Are these changes tested?

No

Are there any user-facing changes?

No

Copy link

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

@andishgar andishgar marked this pull request as draft May 16, 2025 10:35
@andishgar andishgar changed the title [ GH-46396: [C++][Documentation][Statistics] Clarify in the documentation of arrow::Array::Equals, arrow::Array::ApproxEquals, and arrow::Array::EqualsRange that they do not consider arrow::ArrayStatistics May 16, 2025
Copy link

⚠️ GitHub issue #46396 has been automatically assigned in GitHub to PR creator.

@andishgar andishgar changed the title GH-46396: [C++][Documentation][Statistics] Clarify in the documentation of arrow::Array::Equals, arrow::Array::ApproxEquals, and arrow::Array::EqualsRange that they do not consider arrow::ArrayStatistics GH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatistics May 16, 2025
@andishgar andishgar force-pushed the add-document-for-equality branch from 96d053d to 4f2bb0a Compare May 16, 2025 11:58
@andishgar andishgar changed the title GH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatistics GH-46396: [C++][Documentation][Statistics] Revise the documentation to clarify that arrow::ArrayStatistics is ignored during arrow::Array comparisons May 16, 2025
@andishgar andishgar marked this pull request as ready for review May 16, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant