Skip to content

Commit

Permalink
fix incorrect docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ankona committed Jan 9, 2024
1 parent 64722c4 commit b6504bb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions smartsim/log.py
Original file line number Diff line number Diff line change
Expand Up @@ -287,9 +287,9 @@ def method_contextualizer(
def _contextualize(
fn: t.Callable[Concatenate[_T, _PR], _RT], /
) -> t.Callable[Concatenate[_T, _PR], _RT]:
"""Sets the value of a contextvar at runtime and executes
the decorated method in a new thread with a context copy
where `ctx_var` is set to the value returned by `ctx_map`"""
"""Executes the decorated method in a cloned context and ensures
`ctx_var` is updated to the value returned by `ctx_map` prior to
calling the decorated method"""

@functools.wraps(fn)
def _contextual(
Expand All @@ -298,7 +298,7 @@ def _contextual(
**kwargs: _PR.kwargs,
) -> _RT:
"""A decorator operator that runs the decorated method in a new
thread with the desired contextual information."""
context with the desired contextual information modified."""

def _ctx_modifier() -> _RT:
"""Helper to simplify calling the target method with the
Expand Down

0 comments on commit b6504bb

Please sign in to comment.