Skip to content

Commit cf1fa3b

Browse files
authored
Complete docstring
Signed-off-by: Philippe Ombredanne <[email protected]>
1 parent d04df2c commit cf1fa3b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/commoncode/hash.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,8 @@ def multi_checksums(location, checksum_names=("md5", "sha1", "sha256", "sha512",
278278
content of the file at ``location``. Use the ``checksum_names`` list of checksum names. The
279279
mapping is guaranted to contains all the requested names as keys. If the location is not a file,
280280
or if the file is empty, the values are None.
281-
The purpose of this function is
281+
The purpose of this function is to avoid read the same file multiple times
282+
to compute different checksums.
282283
"""
283284
if not filetype.is_file(location):
284285
return {name: None for name in checksum_names}

0 commit comments

Comments
 (0)