From d0366229ecf108de2acab9e291d4d5f9d0bc0eb6 Mon Sep 17 00:00:00 2001 From: Michael Hudson-Doyle Date: Wed, 22 May 2024 12:06:32 +1200 Subject: [PATCH] add docstring explaining _get_system return value --- subiquity/server/controllers/filesystem.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/subiquity/server/controllers/filesystem.py b/subiquity/server/controllers/filesystem.py index e1f71f3c..f6d16a38 100644 --- a/subiquity/server/controllers/filesystem.py +++ b/subiquity/server/controllers/filesystem.py @@ -340,6 +340,13 @@ class FilesystemController(SubiquityController, FilesystemManipulator): async def _get_system( self, variation_name, label ) -> Tuple[Optional[SystemDetails], bool]: + """Return system information for a given system label. + + The return value is a SystemDetails object (if any) and True if + the system was found in the layer that the installer is running + in or False if the source layer needed to be mounted to find + it. + """ systems = await self.app.snapdapi.v2.systems.GET() labels = {system.label for system in systems.systems} if label in labels: