GH-50394: [Docs][C++] Reduce Sphinx warnings when building HTML#50396
Draft
tadeja wants to merge 2 commits into
Draft
GH-50394: [Docs][C++] Reduce Sphinx warnings when building HTML#50396tadeja wants to merge 2 commits into
tadeja wants to merge 2 commits into
Conversation
|
|
tadeja
changed the title
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
1 participant
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
Fixes Sphinx warnings during the docs build. Doxygen/Breathe expose the multi-line lambda initializers on
writer_pre_finish/writer_post_finishand the macrosARROW_SUPPRESS_DEPRECATION_WARNING/ARROW_UNSUPPRESS_DEPRECATION_WARNINGto Sphinx C++ parses which can't parse them.What changes are included in this PR?
Added
\hideinitializertodataset/file_base.handdataset/scanner.h.Added
ARROW_SUPPRESS_DEPRECATION_WARNINGandARROW_UNSUPPRESS_DEPRECATION_WARNINGtoapidoc/DoxyfilePREDEFINED list so Doxygen strips them from declarations.Are these changes tested?
Yes, locally and on fork CI - logs AMD64 Debian 12 Complete Documentation:
build succeeded, 15 warnings.(down from 26 warnings on main)
Are there any user-facing changes?
No.