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

Tables slice documentation #2456

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented Sep 18, 2024

See ome/openmicroscopy#6411 (comment) and ome/openmicroscopy#6412 for a related effort on the test front.

This ports the contract of the slice API when either or rowNumbers or colNumbers is empty to the Sphinx documentation.

@@ -241,8 +241,10 @@ Main methods

:param long[] colNumbers: A list of column indices to be retrieved.
The results will be returned in the same order as these indices.
If empty or None, all columns will be returned.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe go with null rather than None as this is not strictly Python based documentation?

:param long[] rowNumbers: A list of row indices to be retrieved.
The results will be returned in the same order as these indices.
If empty or None, all rows will be returned.
Copy link
Member

Choose a reason for hiding this comment

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

As above.

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.

2 participants