Docstring improvements.

facebookresearch · Mar 3, 2022 · 84c55ee · 84c55ee
1 parent 04778a4
commit 84c55ee
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/compiler_gym/service/connection.py b/compiler_gym/service/connection.py
@@ -792,7 +792,7 @@ def shutdown(self):
         except ServiceError as e:
             # close() can raise ServiceError if the service exists with a
             # non-zero return code. We swallow the error here as we are
-            # disposing o f the service.
+            # disposing of the service.
             logger.debug(
                 "Ignoring service error during shutdown attempt: %s (%s)",
                 e,

diff --git a/compiler_gym/service/connection_pool.py b/compiler_gym/service/connection_pool.py
@@ -42,6 +42,14 @@ class ServiceConnectionPool:
     <compier_gym.service.CompilerGymServiceConnection.close>`), it is
     automatically released back to the pool so that a future request for the
     same type of service will reuse the connection.
+
+    :ivar pool: A pool of service connections that are ready for use.
+
+    :vartype pool: Dict[ServiceConnectionCacheKey, List[CompilerGymServiceConnection]]
+
+    :ivar allocated: The set of service connections that are currently in use.
+
+    :vartype allocated: Set[CompilerGymServiceConnection]
     """
 
     def __init__(self) -> None: