Skip to content

Commit

Permalink
Added note to pydeephaven example (#4895)
Browse files Browse the repository at this point in the history
* added note

* update note
  • Loading branch information
elijahpetty authored Nov 29, 2023
1 parent f4b314f commit 39c70a4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions py/client/docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@ Subscribe to a ticking table
The `pydeephaven_ticking` package can be used to subscribe to ticking tables. This is useful for getting asynchronous callbacks when
they change. The package maintains a complete local copy of the table and notifies callers when the table changes.

Note that `pydeephaven_ticking` must be built before running this example; find build instructions <ahref='https://github.com/deephaven/deephaven-core/tree/main/py/client-ticking#readme'>here</a>

The listener can be specified either as a python function or as an implementation of the TableListener abstract base class. In the
case of implementing
:py:class:`TableListener <pydeephaven.ticking.TableListener>`
Expand Down

0 comments on commit 39c70a4

Please sign in to comment.