Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dereneaton committed Apr 10, 2017
1 parent 952a911 commit 72a8282
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,15 @@ to generate trees as graph figures. Examples below demonstrate simple usage.
Tree plotting basics
~~~~~~~~~~~~~~~~~~~~~
The ``.draw()`` function generates a plot which is returned as a toyplot.Canvas and
toyplot.axes.cartesian objects. In a jupyter-notebook these will automatically render
within cells of the notebook.
The ``.draw()`` function generates a plot which is returned as two objects,
a ``toyplot.Canvas`` object and a ``toyplot.axes.cartesian`` object.
In a jupyter-notebook the ``canvas`` will automatically render as a figure
in a cell of the notebook.

.. code:: python
tre.draw(width=400, node_labels=True)
canvas, axes = tre.draw(width=400, node_labels=True)
canvas
.. image:: https://cdn.rawgit.com/eaton-lab/toytree/master/docs/readme_fig1.svg
Expand Down

0 comments on commit 72a8282

Please sign in to comment.