Skip to content

Commit 7f0be40

Browse files
author
Christopher Doris
committedAug 19, 2022
docs tweaks [skip ci]
1 parent 5c5cab8 commit 7f0be40

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed
 

‎docs/src/compat.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Some packages require a little extra help to work nicely with PythonCall.
55
Some of these are "fixes" that are silently applied for you, and some are just extra
66
functions to bridge a gap. We aim to keep these as minimal as possible.
77

8-
## Stdlib
8+
## Python standard library
99

1010
Whenever a Python exception is displayed by Julia, `sys.last_traceback` and friends are set. This allows the post-mortem debugger `pdb.pm()` to work. Disable by setting `PythonCall.CONFIG.auto_sys_last_traceback = false`.
1111

12-
## Tabular data & Pandas
12+
## Tabular data / Pandas
1313

1414
The abstract type [`PyTable`](@ref) is for wrapper types around Python tables, providing the
1515
[Tables.jl](https://github.com/JuliaData/Tables.jl) interface. `PyTable(x)` is shorthand
@@ -39,7 +39,7 @@ We also provide a simple MatPlotLib backend: `mpl.use("module://juliacall.matplo
3939
Now you can call `plt.show()` to display the figure with Julia's display mechanism.
4040
You can specify the format like `plt.show(format="png")`.
4141

42-
## GUIs (including MatPlotLib)
42+
## Python GUIs (including MatPlotLib)
4343

4444
### Event loops
4545

@@ -66,4 +66,16 @@ The `juliacall.ipython` IPython extension adds these features to your IPython se
6666
- Calling `display(x)` from Julia will display `x` in IPython.
6767

6868
Enable the extension with `%load_ext juliacall.ipython`.
69-
See https://ipython.readthedocs.io/en/stable/config/extensions/.
69+
See [the IPython docs](https://ipython.readthedocs.io/en/stable/config/extensions/).
70+
71+
## Asynchronous Julia code (including Makie)
72+
73+
Asynchronous Julia code will not normally run while Python is executing, unless it is in a
74+
separate thread.
75+
76+
This can be fixed by calling `jl.yield()` periodically from Python code, allowing the
77+
Julia scheduler to run.
78+
79+
When working at the Python REPL, you may call `juliacall.interactive()` which will allow
80+
Julia async code to run while the prompt is showing. This will allow interactive plots such
81+
as Makie to work.

0 commit comments

Comments
 (0)