search

deephaven / deephaven-core

Deephaven Community Core
Other
257 stars 80 forks source link

Improve Python Client Documentation on Ticking Tables #4029

Open cpwright opened 1 year ago

cpwright commented 1 year ago

Description

When using the size method on a table from the pydeephaven session as in the following:

qc = session.open_table("tt") print("Table size: ", qc.size)

The size attribute does not update. This is the expected behavior according to Jianfeng, but that is not immediately clear from the documentation at https://deephaven.io/core/client-api/python/ (nor is the size attribute).

Expected results

The documentation would explain how the size updates, and overall how the handle would work with respect to ticking tables.

Actual results

The documentation doesn't address it.

Versions

rcaudy commented 1 year ago

Sounds like this is primarily about improving pydocs, but I'd like to re-visit why there's even a size attribute in the client table handle; it doesn't belong there.

chipkent commented 1 year ago

I've noticed the same thing in C++/R. I think the gRPC associated with the table handle has a size field. I can understand how it might make sense to provide this info any time a table handle is acquired or updated, but I also thought it was weird.