Skip to content

Commit ea01e7c

Browse files
committed
docs: Expand module docstring for resource management
1 parent a3fb2a1 commit ea01e7c

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

cardano_node_tests/cluster_management/resources_management.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
"""Functionality for getting a cluster instance that has required resources available."""
1+
"""Functionality for selecting a cluster instance that has required resources available.
2+
3+
Resources can be requested by name (string).
4+
5+
It is also possible to use filters. A filter is a class that gets a list of all unavailable
6+
resources and returns a list of resources that should be used. An example is `OneOf`, which returns
7+
one usable resource from a given list of resources. The unavailable resources passed to the filter
8+
include resources that are unavailable because they are locked, and also resources that were
9+
already selected by preceding filters in the same request.
10+
11+
It is possible to use multiple `OneOf` filters in a single request. For example, using `OneOf`
12+
filter with the same set of resources twice will result in selecting two different resources from
13+
that set.
14+
"""
215

316
import random
417
import typing as tp

0 commit comments

Comments
 (0)