From f8cfbc11004aca409d22e93c7d1105ac788fcfec Mon Sep 17 00:00:00 2001 From: tretrauit Date: Wed, 3 Jan 2024 17:00:58 +0700 Subject: [PATCH] docs: add information on functions.apply_update_archive --- vollerei/common/functions.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/vollerei/common/functions.py b/vollerei/common/functions.py index 49cff62..121f09e 100644 --- a/vollerei/common/functions.py +++ b/vollerei/common/functions.py @@ -13,6 +13,13 @@ _hdiff = HDiffPatch() def apply_update_archive( game: GameABC, archive_file: Path | IOBase, auto_repair: bool = True ) -> None: + """ + Applies an update archive to the game, it can be the game update or a + voicepack update. + + Because this function is shared for all games, you should use the game's + `apply_update_archive()` method instead. + """ # Most code here are copied from worthless-launcher. # worthless-launcher uses asyncio for multithreading while this one uses # ThreadPoolExecutor, probably better for this use case.