Move examples in arrow-csv to docstrings, polish up docs #9001
Conversation
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
alamb
commented
Dec 15, 2025
| //! let batch = csv.next().unwrap().unwrap(); | ||
| //! ``` | ||
| //! | ||
| //! # Example: Numeric calculations on CSV |
Contributor
Author
There was a problem hiding this comment.
Contents of arrow-csv/examples/csv_calculation.rs
| //! - `DataType::Utf8View` | ||
| //! | ||
| //! ## Example with whitespace handling | ||
| //! ## Example: Use [`WriterBuilder`] to control whitespace handling |
Contributor
Author
There was a problem hiding this comment.
This already has the contents of arrow-csv/examples/whitespace_handling.rs, so let's not duplicate it again
| type Bounds = Option<(usize, usize)>; | ||
|
|
||
| /// CSV file reader using [`std::io::BufReader`] | ||
| /// |
Contributor
Author
There was a problem hiding this comment.
I added a few more doc links to make it easier to navigate between the different classes
Contributor
|
Thanks for doing this! |
Contributor
Author
|
Thank you for the review @mhilton |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
while reviewing @xanderbailey's PR in #8960, I found that there are examples for arrow-csv and they are hard to find. Also each example add extra binaries and thus slows down CI and tests. For example the
whitespace_handlingexample makes a new 2.9MB binary:Let's consolidate the examples to make them easier to find
What changes are included in this PR?
Are these changes tested?
We typically require tests for all PRs in order to:
Are there any user-facing changes?
Docs only, no functional changes