Skip to content

Commit 8e471ba

Browse files
committed
docs: ensure docstrings adhear to Google style methods
1 parent 183cd9e commit 8e471ba

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

CodeEntropy/levels/nodes/covariance.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ def run(self, ctx: FrameCtx) -> dict[str, Any]:
5757
"""Compute and store per-frame force/torque (and optional FT) matrices.
5858
5959
Args:
60-
ctx: Frame context dict expected to include:
61-
- "shared": dict containing reduced_universe, groups, levels, beads,
62-
and args
63-
- shared["axes_manager"] (created in static stage)
60+
ctx: Frame context dictionary. Expected to include ``"shared"``,
61+
containing reduced universe, groups, levels, beads, args,
62+
and ``shared["axes_manager"]`` created during the static stage.
6463
6564
Returns:
66-
The frame covariance payload also stored at ctx["frame_covariance"].
65+
The frame covariance payload also stored at
66+
``ctx["frame_covariance"]``.
6767
6868
Raises:
69-
KeyError: If ctx is missing required fields.
69+
KeyError: If ``ctx`` is missing required fields.
7070
"""
7171
shared = self._get_shared(ctx)
7272

0 commit comments

Comments
 (0)