Skip to content

Commit 72a8282

Browse files
committed
readme
1 parent 952a911 commit 72a8282

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,15 @@ to generate trees as graph figures. Examples below demonstrate simple usage.
4848
4949
Tree plotting basics
5050
~~~~~~~~~~~~~~~~~~~~~
51-
The ``.draw()`` function generates a plot which is returned as a toyplot.Canvas and
52-
toyplot.axes.cartesian objects. In a jupyter-notebook these will automatically render
53-
within cells of the notebook.
51+
The ``.draw()`` function generates a plot which is returned as two objects,
52+
a ``toyplot.Canvas`` object and a ``toyplot.axes.cartesian`` object.
53+
In a jupyter-notebook the ``canvas`` will automatically render as a figure
54+
in a cell of the notebook.
5455

5556
.. code:: python
5657
57-
tre.draw(width=400, node_labels=True)
58+
canvas, axes = tre.draw(width=400, node_labels=True)
59+
canvas
5860
5961
6062
.. image:: https://cdn.rawgit.com/eaton-lab/toytree/master/docs/readme_fig1.svg

0 commit comments

Comments
 (0)