Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Array::is_nullable documentation #6615

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Improve Array::is_nullable documentation #6615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions arrow-array/src/array/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,12 @@ pub trait Array: std::fmt::Debug + Send + Sync {

/// Returns `false` if the array is guaranteed to not contain any logical nulls
///
/// In general this will be equivalent to `Array::logical_null_count() != 0` but may differ in the
/// presence of logical nullability, see [`Array::logical_nulls`].
/// This is generally equivalent to `Array::logical_null_count() != 0` unless determining
/// the logical nulls is expensive, in which case this method can return true even for an
/// array without nulls.
///
/// This is also generally equivalent to `Array::null_count() != 0` but may differ in the
/// presence of logical nullability, see [`Array::logical_null_count`] and [`Array::null_count`].
///
/// Implementations will return `true` unless they can cheaply prove no logical nulls
/// are present. For example a [`DictionaryArray`] with nullable values will still return true,
Expand Down
Loading