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. ```