-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Conversation
@github-actions crossbow submit preview-docs |
Revision: cf9e13b Submitted crossbow builds: ursacomputing/crossbow @ actions-a942482c0a
|
There was a problem hiding this 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!
|
Docs preview looks good, see http://crossbow.voltrondata.com/pr_docs/44505/cpp/api/array.html#_CPPv4N5arrow13ChunkLocationE. Merging this. |
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. |
Rationale for this change
Since ChunkLocation is a typedef/alias, it needs to use the
doxygentypedef
Sphinx directive rather thandoxygenstruct
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:
doxygenstruct
directive withdoxygentypedef
:members:
directive as it's not neededAre these changes tested?
Yes.
Are there any user-facing changes?
Yes, though just docs.