This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 2f26de591a Improve Array::is_nullable documentation (#6615)
2f26de591a is described below
commit 2f26de591a9cd5ccdc0d4380eeb36d157ab61af6
Author: Piotr Findeisen <[email protected]>
AuthorDate: Wed Oct 23 09:27:10 2024 +0200
Improve Array::is_nullable documentation (#6615)
---
arrow-array/src/array/mod.rs | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/arrow-array/src/array/mod.rs b/arrow-array/src/array/mod.rs
index 4205d00ec8..7ca59680a6 100644
--- a/arrow-array/src/array/mod.rs
+++ b/arrow-array/src/array/mod.rs
@@ -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,
