Skip to content

Commit a560654

Browse files
committed
doc fixes
1 parent b617464 commit a560654

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,11 @@ version number is returned by `PythonPlot.version`.
5454

5555
### Differences from PyPlot
5656

57-
Compared to the PyPlot package, there are a few differences.
57+
Compared to the PyPlot package, there are a few differences in the API.
5858

5959
* 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.)
60-
* 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.
60+
* The `matplotlibl.pyplot` module is exported as `pyplot` rather than as `plt`.
61+
* 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.
6162

6263
### Exported functions
6364

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

109110
## Interactive versus Julia graphics

0 commit comments

Comments
 (0)