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

Clarify the documentation for the non empty domain CAPI. #4885

Merged
merged 1 commit into from
Apr 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion tiledb/sm/c_api/tiledb.h
Original file line number Diff line number Diff line change
Expand Up @@ -3367,7 +3367,12 @@ TILEDB_EXPORT int32_t tiledb_array_vacuum(

/**
* Retrieves the non-empty domain from an array. This is the union of the
* non-empty domains of the array fragments.
* non-empty domains of the array fragments. This API only works for arrays that
* have numeric dimensions and all dimensions of the same type.
*
* The domain passed in is memory that can contain the number of dimensions * 2
* * sizeof(type of dimension). The previous two is because we return the non
* empty domain as min/max. Dimensions are returned in order.
*
* **Example:**
*
Expand Down
Loading