From fd39d41773e9590432c0782bc6c2825707e9df1a Mon Sep 17 00:00:00 2001
From: Andrew Lamb <andrew@nerdnetworks.org>
Date: Fri, 15 Jul 2022 17:45:49 -0400
Subject: [PATCH] Improve doc strings for as_primtive_array

---
 arrow/src/array/cast.rs | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/arrow/src/array/cast.rs b/arrow/src/array/cast.rs
index d0b77a0d27b..bf6848f9e22 100644
--- a/arrow/src/array/cast.rs
+++ b/arrow/src/array/cast.rs
@@ -20,7 +20,19 @@
 use crate::array::*;
 use crate::datatypes::*;
 
-/// Force downcast ArrayRef to PrimitiveArray<T>
+/// Force downcast of an [`Array`], such as an [`ArrayRef`], to
+/// [`PrimitiveArray<T>`], panic'ing on failure:
+///
+/// ```
+/// # use arrow::array::*;
+/// # use arrow::datatypes::*;
+/// # let arr: ArrayRef = std::sync::Arc::new(Int32Array::from(vec![Some(1)]));
+/// // Downcast an `ArrayRef` to Int32Array / PrimiveArray<Int32>:
+/// let primitive_array: &Int32Array = as_primitive_array(&arr);
+///
+/// // Equivalently:
+/// let primitive_array  = as_primitive_array::<Int32Type>(&arr);
+/// ```
 pub fn as_primitive_array<T>(arr: &dyn Array) -> &PrimitiveArray<T>
 where
     T: ArrowPrimitiveType,