docs: show creation of DFSchema #8132
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
|
Thank you very much @wjones127 |
andygrove
reviewed
Nov 11, 2023
andygrove
reviewed
Nov 11, 2023
andygrove
approved these changes
Nov 11, 2023
Co-authored-by: Andy Grove <andygrove73@gmail.com>
alamb
approved these changes
Nov 12, 2023
There was a problem hiding this comment.
Thank you for this contribution @wjones127 -- I think this will help avoid a bunch of confusion
| /// assert!(df_schema.has_column(&column)); | ||
| /// ``` | ||
| /// | ||
| /// # Converting back to Arrow schema |
There was a problem hiding this comment.
Thank you @wjones127 this is super helpful
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 #8131.
Rationale for this change
I got stuck figuring this out, and noticed there was very little documentation here.
I don't think I yet understand enough about DFSchema to fully document it. For now I'm mostly using unqualified schemas. Therefore, I'm not trying to complete #7724 with this PR.
What changes are included in this PR?
Adds some initial examples.
Are these changes tested?
Examples run with doc tests.
Are there any user-facing changes?