Skip to content

Commit f82cab2

Browse files
committed
GPI-1399: Update get_local_size docs
1 parent 0c49ee3 commit f82cab2

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

src/galaxy/api/plugin.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,10 +1027,9 @@ async def get_local_size(self, game_id: str, context: Any) -> Optional[int]:
10271027
It is preferable to avoid iterating over local game files when overriding this method.
10281028
If possible, please use a more efficient way of game size retrieval.
10291029
1030+
:param game_id: the id of the installed game
10301031
:param context: the value returned from :meth:`prepare_local_size_context`
1031-
:return: game size (in bytes) or `None` if game size cannot be determined;
1032-
'0' if the game is not installed, or if it is not present locally (e.g. installed
1033-
on another machine and accessible via remote connection, playable via web browser etc.)
1032+
:return: the size of the game on a user-owned storage device (in bytes) or `None` if the size cannot be determined
10341033
"""
10351034
raise NotImplementedError()
10361035

0 commit comments

Comments
 (0)