Skip to content

Commit

Permalink
[python] Elaborate docstring re relativity for add-new (#2088) (#2089)
Browse files Browse the repository at this point in the history
Co-authored-by: John Kerl <[email protected]>
  • Loading branch information
github-actions[bot] and johnkerl authored Jan 30, 2024
1 parent 64090ad commit e2ccb4e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions apis/python/src/tiledbsoma/_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,8 @@ def add_new_collection(
linked to by absolute URI in the stored collection, or relative,
in which case the sub-collection will be linked to by relative URI.
The default is to use a relative URI generated based on the key.
Absolute example: ``uri="s3://mybucket/myexperiment/ms/RNA/newchild"``.
Relative example: ``uri="newchild"``.
platform_config:
Platform configuration options to use when
creating this sub-collection. This is passed directly to
Expand Down

0 comments on commit e2ccb4e

Please sign in to comment.