MINOR: [Docs][C++] Fix Sphinx building html warning - #51672
Merged
Merged
Conversation
github-actions
Bot
added
Component: C++
awaiting committer review
tadeja
marked this pull request as ready for review
October 1, 2026 09:51
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The focused configuration change directly addresses the documented parsing warning without affecting runtime behavior.
Review effort: Balanced
Findings: None
What changed in this PR
Adds Doxygen preprocessing for the S3 export macro, allowing Sphinx to resolve S3 API declarations correctly.
Changes:
- Defines
ARROW_S3_EXPORTas empty during Doxygen processing.
| File | Description |
|---|---|
cpp/apidoc/Doxyfile |
Adds the S3 export macro to PREDEFINED. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
raulcd
approved these changes
Oct 1, 2026
raulcd
left a comment
raulcd
left a comment
Member
There was a problem hiding this comment.
Sounds reasonable to me, I've validated that specific Warning doesn't seem to appear anymore:
reading sources... [ 76%] python/generated/pyarrow.dataset.WrittenFile .. python/generated/pyarrow.flight.GeneratorStream
reading sources... [ 81%] python/generated/pyarrow.flight.Location .. python/generated/pyarrow.ipc.RecordBatchFileWriter
reading sources... [ 86%] python/generated/pyarrow.ipc.RecordBatchStreamReader .. python/generated/pyarrow.parquet.Statistics
reading sources... [ 90%] python/generated/pyarrow.parquet.encryption.CryptoFactory .. python/generated/pyarrow.types.is_date64
reading sources... [ 95%] python/generated/pyarrow.types.is_decimal .. python/generated/pyarrow.unify_schemas
reading sources... [100%] python/generated/pyarrow.union .. status
/build/python/docs/source/format/Other.rst:21: ERROR: Error in "deprecated" directive:
1 argument(s) required, 0 supplied.
.. deprecated::
Thanks @tadeja
github-actions
Bot
added
awaiting merge
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
Fix Sphinx building [html] warning
What changes are included in this PR?
Add new macro
ARROW_S3_EXPORTto the PREDEFINED list inDoxyfileAre 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: