Skip to content

Conversation

hiroyuki-sato
Copy link
Collaborator

@hiroyuki-sato hiroyuki-sato commented May 22, 2025

Rationale for this change

The Array section of the API Doc
does not explain FlatArray, PrimitiveArray, and RunEndEncodedArray .

What changes are included in this PR?

Add FlatArray, PrimitiveArray, and RunEndEncodedArray API docs

Are these changes tested?

No. (Document only)

Are there any user-facing changes?

No.

Copy link

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

@hiroyuki-sato
Copy link
Collaborator Author

hiroyuki-sato commented May 22, 2025

Attached image is the preview image of this PR.

  • Where is a good place to put FlatArray and PrimitiveArray? (This PR puts two class definitions in the base category. This is because two classes are defined in the arrow_base.h file.)
  • Run-End Encoded Array too. Should we create create new category?


@raulcd
Copy link
Member

raulcd commented May 22, 2025

@github-actions crossbow submit preview-docs

1 similar comment
@raulcd
Copy link
Member

raulcd commented May 22, 2025

@github-actions crossbow submit preview-docs

Copy link

Revision: 6041e20

Submitted crossbow builds: ursacomputing/crossbow @ actions-682ed9d41c

Task Status
preview-docs GitHub Actions

Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels May 22, 2025
Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

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

Thanks a lot @hiroyuki-sato ! Please feel free to contribute other documentation improvements.

@pitrou pitrou merged commit 3cc284f into apache:main May 22, 2025
7 of 8 checks passed
@pitrou pitrou removed the awaiting merge Awaiting merge label May 22, 2025
@github-actions github-actions bot added the awaiting committer review Awaiting committer review label May 22, 2025
@hiroyuki-sato hiroyuki-sato deleted the topic/cpp-api-doc branch May 22, 2025 12:07
@hiroyuki-sato
Copy link
Collaborator Author

@raulcd @pitrou Thanks!

Copy link

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 3cc284f.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 5 possible false positives for unstable benchmarks that are known to sometimes produce them.

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