Skip to content

Commit 8c117ee

Browse files
committed
Docstring improvements.
1 parent 900ab13 commit 8c117ee

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

compiler_gym/service/connection.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -792,7 +792,7 @@ def shutdown(self):
792792
except ServiceError as e:
793793
# close() can raise ServiceError if the service exists with a
794794
# non-zero return code. We swallow the error here as we are
795-
# disposing o f the service.
795+
# disposing of the service.
796796
logger.debug(
797797
"Ignoring service error during shutdown attempt: %s (%s)",
798798
e,

compiler_gym/service/connection_pool.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ class ServiceConnectionPool:
4242
<compier_gym.service.CompilerGymServiceConnection.close>`), it is
4343
automatically released back to the pool so that a future request for the
4444
same type of service will reuse the connection.
45+
46+
:ivar pool: A pool of service connections that are ready for use.
47+
48+
:vartype pool: Dict[ServiceConnectionCacheKey, List[CompilerGymServiceConnection]]
49+
50+
:ivar allocated: The set of service connections that are currently in use.
51+
52+
:vartype allocated: Set[CompilerGymServiceConnection]
4553
"""
4654

4755
def __init__(self) -> None:

0 commit comments

Comments
 (0)