chore: add comment

Signed-off-by: lstocchi <lstocchi@redhat.com>
containers · Jan 23, 2024 · 6ec8d2a · 6ec8d2a
1 parent ae9f2cf
commit 6ec8d2a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/main/src/plugin/container-registry.ts b/packages/main/src/plugin/container-registry.ts
@@ -875,6 +875,12 @@ export class ContainerProviderRegistry {
     ];
   }
 
+  /**
+   * it finds a running podman provider by fetching all internalProviders.
+   * It filters by checking the libpodApi
+   * @returns a running podman provider
+   * @throws if no running podman provider is found
+   */
   public getFirstRunningPodmanContainerProvider(): InternalContainerProvider {
     // grab the first running podman provider
     const matchingPodmanContainerProvider = Array.from(this.internalProviders.values()).find(