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.

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

GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation #44505

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

amoeba
Copy link
Member

@amoeba amoeba commented Oct 23, 2024

Rationale for this change

Since ChunkLocation is a typedef/alias, it needs to use the doxygentypedef Sphinx directive rather than doxygenstruct in order for it to show up in the generated HTML. Otherwise we get an error.

What changes are included in this PR?

Just docs:

  • Replace doxygenstruct directive with doxygentypedef
  • Remove :members: directive as it's not needed

Are these changes tested?

Yes.

Are there any user-facing changes?

Yes, though just docs.

@amoeba
Copy link
Member Author

amoeba commented Oct 23, 2024

@github-actions crossbow submit preview-docs

Copy link

Revision: cf9e13b

Submitted crossbow builds: ursacomputing/crossbow @ actions-a942482c0a

Task Status
preview-docs GitHub Actions

Copy link
Collaborator

@anjakefala anjakefala left a comment

Choose a reason for hiding this comment

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

Thank you! I should've checked in on that!

@github-actions github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 23, 2024
@amoeba amoeba changed the title MINOR: [Docs][C++] Fix documentation directive for ChunkLocation GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation Oct 23, 2024
Copy link

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

@amoeba
Copy link
Member Author

amoeba commented Oct 23, 2024

I upgraded this to a non-MINOR PR (matching issue: #44506) in case we choose to create a new 18.0.0 RC in which case we'll want to include this with the original patch, #34535.

@amoeba
Copy link
Member Author

amoeba commented Oct 23, 2024

@amoeba amoeba merged commit 5ea3aa1 into apache:main Oct 23, 2024
8 checks passed
@amoeba amoeba removed the awaiting committer review Awaiting committer review label Oct 23, 2024
Copy link

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

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.

2 participants