relikd/icnsutil
1
0
Fork 0
Code Issues Pull Requests Releases Activity

docs: clarify usage of iterator in IcnsFile.verify

Browse Source
This commit is contained in:
relikd
2022-08-30 08:40:00 +02:00
committed by GitHub
parent 3b6cdd5f82
commit 7f6c73751f
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

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