Skip to content

Commit 135428b

Browse files
committed
docs(doc-string): update doc-strings for ConformationalDAG
1 parent b1cc699 commit 135428b

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

CodeEntropy/levels/conformation_dag.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,7 @@
1717

1818

1919
class ConformationDAG:
20-
"""Execute conformational-state construction for selected trajectory frames.
21-
22-
The first implementation intentionally preserves the existing serial
23-
ConformationStateBuilder behaviour. Later issues can replace this internal
24-
implementation with chunked map-reduce execution.
25-
"""
20+
"""Execute conformational-state construction for selected trajectory frames."""
2621

2722
def __init__(self, universe_operations: Any | None = None) -> None:
2823
self._builder = ConformationStateBuilder(
@@ -43,7 +38,15 @@ def execute(
4338
*,
4439
progress: object | None = None,
4540
) -> dict[str, ConformationalStates]:
46-
"""Compute conformational states and store them in shared workflow data."""
41+
"""Compute conformational states and store them in shared workflow data.
42+
43+
Args:
44+
shared_data: Shared workflow data containing ``reduced_universe``,
45+
``levels``, ``groups``, ``frame_selection``, and ``args.bin_width``.
46+
progress: Optional progress sink forwarded to the conformation builder.
47+
Returns:
48+
A dictionary containing the computed ``conformational_states`` mapping.
49+
"""
4750
universe = shared_data["reduced_universe"]
4851
levels = shared_data["levels"]
4952
groups = shared_data["groups"]

0 commit comments

Comments
 (0)