summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2025-04-17 16:52:40 +0100
committerPeter LaFosse <peter@vector35.com>2025-04-18 08:10:21 -0400
commit29e0a5d011d05f1c2f43942425bf538f898eeee0 (patch)
tree5757772fb68ab7b14ef326d5e5bdeef6ed7230b3 /docs/guide
parent6e3e682b3409b17dbb63b4ba445be5c120e62fd6 (diff)
add note to console docs about shared vs unified python instance, resolves #6651
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/index.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/guide/index.md b/docs/guide/index.md
index aea9db6b..a5908569 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -890,6 +890,9 @@ The scripting console is not a full IDE, but it has several convenience features
- `<CTRL>-R` allows for reverse-searching your console history
- `<UP>` and `<DOWN>` can be used to view the command-history
+???+ Tip "Tip"
+ All scripting consoles share a single python instance. This is an intentional design choice and has the following benefits: you can create variables in one tab/window and then access it in another. The downside is that if you run a long-running script for example, the console will still be blocked in other tabs and windows. This is a known trade-off and not expected to change.
+
### Magic Console Variables
The interactive python prompt also has several built-in "magic" functions and variables. Some are read-only, and some are writable to provide convenient interactivity between the UI and console: