Skip to content

Commit bb5bcd9

Browse files
committed
docs: Add detailed module docstring to cluster_management/manager.py
1 parent ea01e7c commit bb5bcd9

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

cardano_node_tests/cluster_management/manager.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
"""Functionality for managing cluster instances."""
1+
"""High-level management of cluster instances.
2+
3+
This module provides the `ClusterManager` class, which is the main interface for tests to get a
4+
fully initialized cluster instance. The `ClusterManager` is responsible for selecting an available
5+
cluster instance that meets the test's resource requirements, preparing the `clusterlib` object,
6+
and performing cleanup actions after the test has finished.
7+
8+
The `ClusterManager` is instantiated by the `cluster_manager` fixture for each test worker and is
9+
used by the `cluster` fixture to get a cluster instance for a test.
10+
"""
211

312
import contextlib
413
import dataclasses

0 commit comments

Comments
 (0)