GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation #44505
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Component: Documentation
awaiting review
|
@github-actions crossbow submit preview-docs |
|
Revision: cf9e13b Submitted crossbow builds: ursacomputing/crossbow @ actions-a942482c0a
|
anjakefala
approved these changes
Oct 23, 2024
github-actions
bot
added
awaiting committer review
amoeba
changed the title
|
|
|
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. |
amoeba
added a commit
that referenced
this pull request
Nov 11, 2024
…44505) ### 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. * GitHub Issue: #44506 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale for this change
Since ChunkLocation is a typedef/alias, it needs to use the
doxygentypedefSphinx directive rather thandoxygenstructin order for it to show up in the generated HTML. Otherwise we get an error.What changes are included in this PR?
Just docs:
doxygenstructdirective withdoxygentypedef:members:directive as it's not neededAre these changes tested?
Yes.
Are there any user-facing changes?
Yes, though just docs.