Add documentation examples for StringViewBuilder::write_str
#1
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
commented
Nov 22, 2024
| /// let array = builder.finish(); | ||
| /// | ||
| /// let expected = vec![Some("hello"), None, Some("world")]; | ||
| /// let actual: Vec<_> = array.iter().collect(); | ||
| /// assert_eq!(expected, actual); | ||
| /// ``` | ||
| /// | ||
| /// /// # Example incrementally writing strings with `std::fmt::Write` |
There was a problem hiding this comment.
This test currently fails like this
assertion `left == right` failed
left: "foo"
right: "foobarbaz"
Left: foo
Right: foobarbaz
<Click to see difference>
thread 'main' panicked at arrow-array/src/builder/generic_bytes_view_builder.rs:22:1:
assertion `left == right` failed
left: "foo"
right: "foobarbaz"
stack backtrace:
0: rust_begin_unwind
at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/std/src/panicking.rs:662:5
1: core::panicking::panic_fmt
at /rustc/f6e511eec7342f59a25f7c0534f1dbea00d01b14/library/core/src/panicking.rs:74:14
2: core::panicking::assert_failed_inner
3: core::panicking::assert_failed
4: rust_out::main::_doctest_main_arrow_array_src_builder_generic_bytes_view_builder_rs_492_0
5: rust_out::main
6: core::ops::function::FnOnce::call_once
note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
(because each call to write! generates a new row)
|
LGTM, thanks you so much @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.
Note this targets apache#6719 from @tlm365
This adds an example for using the write_str method that expects the builder to behave the same as
https://docs.rs/arrow/latest/arrow/array/builder/type.GenericStringBuilder.html#example-incrementally-writing-strings-with-stdfmtwrite