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.

Sign up for GitHub

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

Jump to bottom

[Docs][C++] Fix documentation directive for ChunkLocation #44506

Closed
amoeba opened this issue Oct 23, 2024 · 1 comment
Closed

[Docs][C++] Fix documentation directive for ChunkLocation #44506

amoeba opened this issue Oct 23, 2024 · 1 comment
Assignees
@amoeba
Labels
backport-candidate Component: C++ Component: Documentation Type: bug
Milestone
18.1.0

Comments

@amoeba
Copy link
Member

amoeba commented Oct 23, 2024

Describe the bug, including details regarding any error messages, version, and platform.

#44357 was merged yesterday and I noticed when building the docs locally that we get an error related to the particular Sphinx directive we used for ChunkLocation:

doxygenstruct: Cannot find class “arrow::ChunkLocation” in doxygen xml output for project “arrow_cpp” from directory: ../../cpp/apidoc/xml

ChunkLocation is a typedef/alias so it should use the doxygentypedef directive to be properly documented.

I originally filed a a minor PR for this, #44505, but am now creating an issue and updating the PR so we can track this alongside #34535 as a backport candidate (i.e., they should be cherry-picked together).

Component(s)

C++, Documentation
@amoeba amoeba added this to the 19.0.0 milestone Oct 23, 2024
@github-actions github-actions bot mentioned this issue Oct 23, 2024
Merged
amoeba added a commit that referenced this issue Oct 23, 2024
@amoeba
GH-44506: [Docs][C++] Fix documentation directive for ChunkLocation (#…
5ea3aa1 
…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]>
@amoeba
Copy link
Member Author

amoeba commented Oct 23, 2024

Issue resolved by pull request 44505
#44505

@amoeba amoeba closed this as completed Oct 23, 2024
@assignUser assignUser modified the milestones: 19.0.0, 18.1.0 Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amoeba amoeba

Labels
backport-candidate Component: C++ Component: Documentation Type: bug
Projects
None yet
Milestone
18.1.0
Development

No branches or pull requests
2 participants
@amoeba @assignUser