From 919e462f88b5fc558e0f6e9b1fb213e38e64e38b Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Sun, 8 Oct 2023 15:57:18 -0400 Subject: [PATCH] Write more comprehensive `Portal.cancel_actor()` doc str --- tractor/_portal.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tractor/_portal.py b/tractor/_portal.py index 9016eda..cf13d9b 100644 --- a/tractor/_portal.py +++ b/tractor/_portal.py @@ -191,7 +191,15 @@ class Portal: ) -> bool: ''' - Cancel the actor on the other end of this portal. + Cancel the actor runtime (and thus process) on the far + end of this portal. + + **NOTE** THIS CANCELS THE ENTIRE RUNTIME AND THE + SUBPROCESS, it DOES NOT just cancel the remote task. If you + want to have a handle to cancel a remote ``tri.Task`` look + at `.open_context()` and the definition of + `._context.Context.cancel()` which CAN be used for this + purpose. ''' if not self.channel.connected():