Repository navigation
MINOR: [Docs][C++] Fix doxygenfile path for arrow/flight/transport.h - #51677
Merged
Merged
Conversation
Member
Author
|
@github-actions crossbow submit preview-docs |
|
Revision: 15a1ce7 Submitted crossbow builds: ursacomputing/crossbow @ actions-717db60522
|
Member
Author
|
@github-actions crossbow submit preview-docs |
|
Revision: 2cac6e6 Submitted crossbow builds: ursacomputing/crossbow @ actions-7d9e234f0a
|
Member
Author
|
Section "Implementing Custom Transports" generates OK in preview-docs |
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The targeted path correction is valid and unambiguous.
Review effort: Balanced
Findings: None
What changed in this PR
Updates Flight API documentation for Breathe 5 compatibility.
Changes:
- Uses the Doxygen-indexed
transport.hfilename.
| File | Description |
|---|---|
docs/source/cpp/api/flight.rst |
Fixes the custom transport documentation directive. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or 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
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
Warning: doxygenfile: Cannot find file “arrow/flight/transport.h(and Sphinx building html shows the same warning at flight.rst:207)
New Breathe version 5.0.0 (breathe-doc/breathe#967, breathe-doc/breathe#1029) checks
doxygenfileagainst Doxygen's index (file name transport.h) and no longer full path.What changes are included in this PR?
Use path
transport.hwhich works both with Breathe 4.x and 5.xAre these changes tested?
Yes.
Are there any user-facing changes?
No.
Was AI used for this PR?
PR code and description written by:
Reviewed before submission by: