MINOR: [C++][Docs] Add \deprecated tag to deprecated BufferReader constructor #38721
Conversation
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
amoeba
changed the title
github-actions
bot
added
awaiting merge
raulcd
approved these changes
Nov 23, 2023
|
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 65fc1e7. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 1 possible false positive for unstable benchmarks that are known to sometimes produce them. |
dgreiss
pushed a commit
to dgreiss/arrow
that referenced
this pull request
Feb 19, 2024
…structor (apache#38721) ### Rationale for this change The PR [apacheGH-37360](apache#37360) for issue [apacheGH-37212](apache#37212) deprecated three BufferReader constructors and I noticed one of them was missing a `\deprecated` command. ### What changes are included in this PR? This adds a `\deprecated` command one of the deprecated constructors with a message. The other two didn't need it because they weren't already documented. i.e., they weren't listed under https://arrow.apache.org/docs/cpp/api/io.html so documenting them at this point just to add `\deprecated` wouldn't make sense. ### Are these changes tested? No, this is a simple docs change. ### Are there any user-facing changes? Yes, this adds a notice to the docs for this particular method. Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
The PR GH-37360 for issue GH-37212 deprecated three BufferReader constructors and I noticed one of them was missing a
\deprecatedcommand.What changes are included in this PR?
This adds a
\deprecatedcommand one of the deprecated constructors with a message. The other two didn't need it because they weren't already documented. i.e., they weren't listed under https://arrow.apache.org/docs/cpp/api/io.html so documenting them at this point just to add\deprecatedwouldn't make sense.Are these changes tested?
No, this is a simple docs change.
Are there any user-facing changes?
Yes, this adds a notice to the docs for this particular method.