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

Add documentation for ome/omero-py#418 #2441

Merged
merged 3 commits into from
Jul 18, 2024

Conversation

chris-allan
Copy link
Member

Add documentation for ome/omero-py#418

Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth updating theomero.grid.Table method signatures in this page to mention the optional current keyword allowing to specify the Ice context as a dictionary?
For someone who has no experience with the tables API, this would make at least clarify where the omero.tables.include_row_numbers is expected to be passed.

As per https://github.com/ome/omero-py/pull/418/files, the readCoordinates API should also respect the inclusion flag and could also be annotated with a similar note.

@will-moore
Copy link
Member

As suggested, an example e.g. t.slice([0], [0,1], {"omero.tables.include_row_numbers": "false"}) would help clarify the method signature.

@chris-allan chris-allan force-pushed the tables-row-numbers branch 3 times, most recently from 7ea9c5a to 9e2600c Compare July 11, 2024 15:42
Copy link
Member

@will-moore will-moore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks

@jburel jburel merged commit 3af440c into ome:develop Jul 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants