From 7f6c73751f8d830c368da43f0c98e3ef816626ef Mon Sep 17 00:00:00 2001
From: relikd <info@relikd.de>
Date: Tue, 30 Aug 2022 08:40:00 +0200
Subject: [PATCH] docs: clarify usage of iterator in IcnsFile.verify

---
 README.md | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 89c200d..d88bb03 100644
--- a/README.md
+++ b/README.md
@@ -90,14 +90,16 @@ if img.remove_media('TOC '):
 img.write('Existing.icns', toc=True)
 
 # print
-# result type string
+# return type str
 desc = icnsutil.IcnsFile.description(fname, indent=2)
 print(desc)
 
 # verify valid format
-# result type objet(list)
-verify = icnsutil.IcnsFile.verify(fname)
-print(list(verify))
+# return type Iterator[str]
+itr = icnsutil.IcnsFile.verify(fname)
+print(list(itr))
+# If you just want to check if a file is faulty, you can use `any(itr)` instead.
+# This way it will not test all checks but break early after the first hit.
 ```