Skip to content

Commit 4e540ee

Browse files
authored
Merge pull request #105 from ianhi/master
rephrase hold_canvas explanation
2 parents 09ca4e0 + 0a07561 commit 4e540ee

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/source/basic_usage.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,12 @@ Optimizing drawings
6262
-------------------
6363

6464
By default, the Python ``Canvas`` object sends all the drawings commands like ``fill_rect``
65-
and ``arc`` one by one through the widgets communication layer. This communication is
66-
limited to 1000 commands/s if you did not change internal Jupyter parameters, and it can
67-
be extremely slow to send commands one after the other.
68-
69-
We provide a ``hold_canvas`` context manager which allows you to hold all the commands and
70-
send them in a single batch at the end.
71-
72-
``hold_canvas`` must be used without moderation.
65+
and ``arc`` one by one through the widgets communication layer. This communication is limited
66+
to 1000 commands/s and it can be extremely slow to send commands one after the other.
67+
You can increase this limit via internal Jupyter `parameters <https://github.com/martinRenou/ipycanvas/issues/102>`_,
68+
however this is not recommended as it can lead to instability. Instead we provide a ``hold_canvas``
69+
context manager which allows you to hold all the commands and send them in a single batch at the end. For
70+
optimal performance you should try to use ``hold_canvas`` as much as possible.
7371

7472
.. code:: Python
7573

0 commit comments

Comments
 (0)