Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Python Client Documentation on Ticking Tables #4029

Open
cpwright opened this issue Jun 20, 2023 · 2 comments
Open

Improve Python Client Documentation on Ticking Tables #4029

cpwright opened this issue Jun 20, 2023 · 2 comments
Assignees
Labels
2023_triagedNoMilestone bug Something isn't working documentation Improvements or additions to documentation python python-client
Milestone

Comments

@cpwright
Copy link
Contributor

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

  • Deephaven: 0.25.2
@cpwright cpwright added bug Something isn't working triage labels Jun 20, 2023
@rcaudy rcaudy added python python-client documentation Improvements or additions to documentation and removed triage labels Jun 20, 2023
@rcaudy rcaudy added this to the June 2023 milestone Jun 20, 2023
@rcaudy
Copy link
Member

rcaudy commented Jun 20, 2023

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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2023_triagedNoMilestone bug Something isn't working documentation Improvements or additions to documentation python python-client
Projects
None yet
Development

No branches or pull requests

6 participants