Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[C++][Docs] arrow::RecordBatch::MakeStatisticsArray()'s docstring refers a wrong URL #45587

Closed
arashandishgar opened this issue Feb 20, 2025 · 1 comment
Closed

[C++][Docs] arrow::RecordBatch::MakeStatisticsArray()'s docstring refers a wrong URL #45587

arashandishgar opened this issue Feb 20, 2025 · 1 comment
Assignees
@arashandishgar
Labels
Component: C++ Component: Documentation Type: bug
Milestone
20.0.0

Comments

@arashandishgar
Copy link
Contributor

Describe the bug, including details regarding any error messages, version, and platform.

as follow up link , the below link is no longer exist and shoud be replaced https://arrow.apache.org/docs/format/StatisticsSchema.html

arrow/cpp/src/arrow/record_batch.h

Line 289 in f9283d0

/// https://arrow.apache.org/docs/format/CDataInterfaceStatistics.html

Component(s)

C++, Documentation
@github-actions github-actions bot mentioned this issue Feb 20, 2025
Merged
@kou kou changed the title [C++][Docs]fix the document incorrectness in MakeStatisticsArray method in RecordBatch class [C++][Docs] arrow::RecordBatch::MakeStatisticsArray()' docstring refers a wrong URL Feb 20, 2025
kou pushed a commit that referenced this issue Feb 21, 2025
@arashandishgar
GH-45587: [C++][Docs] Fix the statistics schema link in `arrow::Recor…
5e5fb07 
…dBatch::MakeStatisticsArray()`'s docstring (#45588)

### Rationale for this change

`arrow::RecordBatch::MakeStatisticsArray()`'s docstring uses https://arrow.apache.org/docs/format/CDataInterfaceStatistics.html not https://arrow.apache.org/docs/format/StatisticsSchema.html for statistics schema URL.

Because #44252 assumed that we use #43553 but we use #45058 finally.

### What changes are included in this PR?

Fix URL.

### Are these changes tested?
It does not need since just a correction in document

### Are there any user-facing changes?
No, Just a correction in document
* GitHub Issue: #45587

Authored-by: arash andishgar <arashandishgar1@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
@kou kou added this to the 20.0.0 milestone Feb 21, 2025
@kou
Copy link
Member

kou commented Feb 21, 2025

Issue resolved by pull request 45588
#45588

@kou kou closed this as completed Feb 21, 2025
@kou kou changed the title [C++][Docs] arrow::RecordBatch::MakeStatisticsArray()' docstring refers a wrong URL [C++][Docs] arrow::RecordBatch::MakeStatisticsArray()'s docstring refers a wrong URL Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arashandishgar arashandishgar

Labels
Component: C++ Component: Documentation Type: bug
Projects
None yet
Milestone
20.0.0
Development

No branches or pull requests
2 participants
@kou @arashandishgar