Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
stevengj committed Apr 13, 2022
1 parent b617464 commit a560654
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,11 @@ version number is returned by `PythonPlot.version`.

### Differences from PyPlot

Compared to the PyPlot package, there are a few differences.
Compared to the PyPlot package, there are a few differences in the API.

* To avoid type piracy, the functions `show`, `close`, `step`, and `fill` are renamed to `pltshow`, `pltclose`, `pltstep`, and `pltfill`, respectively. (You can also access them as `PythonPlot.show` etcetera.)
* The PythonCall performs many fewer automatic conversions from Python types to Julia types (in comparison to PyCall). If you need to convert Matplotlib return values to native Julia objects, you'll need to do `using PythonCall` and call its `pyconvert(T, o)` or other conversion functions.
* The `matplotlibl.pyplot` module is exported as `pyplot` rather than as `plt`.
* The PythonCall package performs many fewer automatic conversions from Python types to Julia types (in comparison to PyCall). If you need to convert Matplotlib return values to native Julia objects, you'll need to do `using PythonCall` and call its `pyconvert(T, o)` or other conversion functions.

### Exported functions

Expand Down Expand Up @@ -103,7 +104,7 @@ function (`plot` etc.) is evaluated.
However, if you use PythonPlot from a Julia script that is run non-interactively
(e.g. `julia myscript.jl`), then Matplotlib is executed in
[non-interactive mode](http://matplotlib.org/faq/usage_faq.html#what-is-interactive-mode):
a plot window is not opened until you run `show()` (equivalent to `pyplot.show()`
a plot window is not opened until you run `pyshow()` (equivalent to `pyplot.show()`
in the Python examples).

## Interactive versus Julia graphics
Expand Down

0 comments on commit a560654

Please sign in to comment.