Minor: consolidate ConfigExtension example into API docs #13954
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
alamb
changed the title
alamb
commented
Dec 31, 2024
alamb
commented
Dec 31, 2024
| /// This mechanism can be used to pass configuration to user defined functions | ||
| /// or optimizer passes | ||
| /// | ||
| /// # Example |
There was a problem hiding this comment.
this is the same example, moved into the docs
11 tasks
github-actions
bot
removed
the
documentation
jonahgao
approved these changes
Jan 1, 2025
datafusion/common/src/config.rs
Outdated
| @@ -901,6 +941,8 @@ pub trait ConfigExtension: ExtensionOptions { | |||
| } | |||
|
|
|||
| /// An object-safe API for storing arbitrary configuration | |||
| /// do | |||
There was a problem hiding this comment.
This doesn't seem to be displayed very well in cargo doc.
There was a problem hiding this comment.
Thank you for this good catch. I am not sure why I made this change. Fixed in c433575
It looks much better now
|
Thanks @alamb |
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 example for ConfigExtensions is:
Thus I think it belongs in the API docs rather than a standalone example
What changes are included in this PR?
Move the example for
ConfigExtensioninto the API docsAre these changes tested?
Yes by CI
Are there any user-facing changes?
more API docs