docs: fix malformed rustdoc for bit_and/bit_or/bit_xor expr fns - #25997
Open
jackylee-ch wants to merge 1 commit into
Open
jackylee-ch wants to merge 1 commit into
jackylee-ch wants to merge 1 commit into
Conversation
The make_bitwise_udaf_expr_and_func! macro built the expr fn doc by
concat!-ing "Returns the bitwise", stringify!($OPR_TYPE) and "of a
group of values" with no separators, so docs.rs rendered e.g. "Returns
the bitwiseBitwiseOperationType :: Andof a group of values". Pass a
readable operation name ("AND"/"OR"/"XOR") instead, yielding "Returns
the bitwise AND of a group of values".
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #25997 +/- ##
==========================================
- Coverage 82.64% 82.64% -0.01%
==========================================
Files 1147 1147
Lines 445491 445502 +11
Branches 445491 445502 +11
==========================================
+ Hits 368162 368164 +2
- Misses 54972 54979 +7
- Partials 22357 22359 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Which issue does this PR close?
Rationale for this change
The
bit_and/bit_or/bit_xorexpr helpers build their rustdoc in themake_bitwise_udaf_expr_and_func!macro byconcat!-ing"Returns the bitwise",stringify!($OPR_TYPE)and"of a group of values"with no separators. Sincestringify!(BitwiseOperationType::And)isBitwiseOperationType :: And, docs.rs rendersReturns the bitwiseBitwiseOperationType :: Andof a group of values.What changes are included in this PR?
The macro now takes a readable operation name (
"AND"/"OR"/"XOR"), producingReturns the bitwise AND of a group of values.What is the testing strategy for this PR?
cargo doc -p datafusion-functions-aggregate: the three expr fns now renderReturns the bitwise {AND,OR,XOR} of a group of values.Are there any user-facing changes?
Corrected rustdoc for the
bit_and/bit_or/bit_xorexpression functions. No behavior change.