docs: document ctx.activate() and ctx.override()

mcbeet · Feb 18, 2021 · 286eca2 · 286eca2
1 parent c1483d0
commit 286eca2
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/beet/toolchain/context.py b/beet/toolchain/context.py
@@ -76,6 +76,7 @@ def inject(self, cls: Callable[["Context"], InjectedType]) -> InjectedType:
 
     @contextmanager
     def activate(self):
+        """Push the context directory to sys.path and handle cleanup to allow module reloading."""
         sys.path.append(self._path_entry)
 
         try:
@@ -96,6 +97,7 @@ def activate(self):
 
     @contextmanager
     def override(self, **meta: Any):
+        """Temporarily update the context meta."""
         to_restore = {}
         to_remove = set()