This is an automated email from the ASF dual-hosted git repository.
brycemecum pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 5ea3aa1f91 GH-44506: [Docs][C++] Fix documentation directive for
ChunkLocation (#44505)
5ea3aa1f91 is described below
commit 5ea3aa1f91710473a619ac96cf9bde782efc5476
Author: Bryce Mecum <[email protected]>
AuthorDate: Tue Oct 22 18:36:01 2024 -0700
GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation (#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]>
---
docs/source/cpp/api/array.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/source/cpp/api/array.rst b/docs/source/cpp/api/array.rst
index 133a432884..a87e3810c4 100644
--- a/docs/source/cpp/api/array.rst
+++ b/docs/source/cpp/api/array.rst
@@ -88,9 +88,8 @@ Chunked Arrays
:project: arrow_cpp
:members:
-.. doxygenstruct:: arrow::ChunkLocation
+.. doxygentypedef:: arrow::ChunkLocation
:project: arrow_cpp
- :members:
.. doxygenstruct:: arrow::TypedChunkLocation
:project: arrow_cpp
