From 87fa029bdd93fc5aa162371e37677f79a3fb3575 Mon Sep 17 00:00:00 2001
From: Tao-Yida <yida.tao@outlook.com>
Date: Sun, 18 Jan 2026 04:02:54 +0800
Subject: [PATCH] Fix Example 1 documentation: pipeline() returns numpy array,
 not dict

---
 doc/source/example_usage.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/source/example_usage.rst b/doc/source/example_usage.rst
index ddecf3a..d8a5444 100644
--- a/doc/source/example_usage.rst
+++ b/doc/source/example_usage.rst
@@ -16,7 +16,11 @@ To use the default pipeline which contains all available augmentations and sensi
 
     image = cv2.imread("image.png")
 
-    data = pipeline(image)
+    # 1. Returns numpy array directly
+    augmented = pipeline(image)
+
+    # 2. Explicitly request dictionary
+    data = pipeline.augment(image, return_dict=1)
 
     augmented = data["output"]