Support multiple alternative syntaxes in the user_doc macro, port trim to use new macro
#13952
Conversation
This file contains 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
alamb
approved these changes
Dec 31, 2024
There was a problem hiding this comment.
Thank you @delamarch3 -- this is great !
FYI @comphead and @Chen-Yuan-Lai
| @@ -258,7 +258,7 @@ pub fn user_doc(args: TokenStream, input: TokenStream) -> TokenStream { | |||
| datafusion_doc::Documentation::builder(datafusion_doc::DocSection { include: #doc_section_include, label: #doc_section_lbl, description: #doc_section_description }, | |||
| #description.to_string(), #syntax_example.to_string()) | |||
| #sql_example | |||
| #alt_syntax_example | |||
| #(#alt_syntax_example)* | |||
There was a problem hiding this comment.
🤯 -- very nice @delamarch3
Thank you
alamb
changed the title
user_doc macrouser_doc macro, port trim to use new macro
comphead
approved these changes
Dec 31, 2024
11 tasks
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?
Closes #13944
Rationale for this change
As explained in #13944, the
user_docmacro doesn't support multiple alternative syntaxes which has preventedtrimfrom using it.What changes are included in this PR?
Build a list of alternative syntax examples in the macro
Use
user_docfortrimAre these changes tested?
I have run
./dev/update_function_docs.shand there are no changesAre there any user-facing changes?
No