doc-gen: make user_doc to work with predefined consts #14086
Merged
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
ding-young
force-pushed
the
doc-section
branch
from
346c919 to
fcbc4a3
Compare
comphead
reviewed
Jan 13, 2025
comphead
reviewed
Jan 13, 2025
|
Thanks @ding-young I think we are very close. |
|
For MSRV I believe you need to update the codebase and run |
ding-young
force-pushed
the
doc-section
branch
from
fcbc4a3 to
3ae466d
Compare
ding-young
commented
Jan 15, 2025
datafusion/macros/src/user_doc.rs
Outdated
Comment on lines
189
to
194
| if doc_section_lbl.is_none() { | ||
| eprintln!("label for doc_section should exist"); | ||
| } | ||
| let label = doc_section_lbl.as_ref().unwrap().value(); | ||
| // Try to find a predefined const by label first. | ||
| // If there is no match but label exists, default value will be used for include and description |
There was a problem hiding this comment.
I made the changes here
ding-young
commented
Jan 15, 2025
datafusion/macros/src/user_doc.rs
Outdated
Comment on lines
28
to
29
| /// For `doc_section`, this macro will try to find corresponding predefined `DocSection` by label field | ||
| /// Predefined `DocSection` can be found in datafusion/expr/src/udf.rs |
There was a problem hiding this comment.
also documented here
ding-young
force-pushed
the
doc-section
branch
2 times, most recently
from
d00e65a to
0590e5f
Compare
ding-young
force-pushed
the
doc-section
branch
from
0590e5f to
0a7bd9d
Compare
|
@comphead Thank you for review. Please tell me if there is any suggestion about the documentation or else. |
comphead
approved these changes
Jan 15, 2025
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 #14001 .
Rationale for this change
What changes are included in this PR?
This pr modifies
user_docto findlabelonly for givendoc_sectionattribute and try correspondent const from predefinedDocSections. If there is no match but label exists, (ex.General Functions) it will automatically fillincludeanddescriptionwith default value as before.Are these changes tested?
will test with github CI.
Are there any user-facing changes?