docs: fix docs for verify_game_file

This commit is contained in:
tretrauit 2022-09-20 17:45:09 +07:00
parent 208b34c9df
commit 66163f8f45
Signed by: tretrauit
GPG Key ID: CDDE1C97EE305DAF
1 changed files with 10 additions and 1 deletions

View File

@ -598,7 +598,16 @@ class Game:
ignore_mismatch=True,
):
"""
This function is an alias to worthless.game.get_voicepack_archive_type
Verifies a game file
Args:
file: The file to verify
pkg_version: The pkg_version file to read MD5 from, if not specified it'll use
the file from the current game installation
ignore_mismatch: Do not raise exception if a file has mismatch MD5, instead
return as a (file, expected md5, actual md5) tuple
Returns:
None if all files are good, (file, expected md5, actual md5) if the file has mismatch md5
"""
if pkg_version is None:
pkg_version = self._game_dir.joinpath("pkg_version")