Skip to content

Commit 993947b

Browse files
committed
list_with_delimiter doc update
1 parent 7a5c6ba commit 993947b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

obstore/python/obstore/_list.pyi

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,11 @@ def list_with_delimiter(store: ObjectStore, prefix: str | None = None) -> ListRe
195195
metadata.
196196
197197
Prefixes are evaluated on a path segment basis, i.e. `foo/bar/` is a prefix of
198-
`foo/bar/x` but not of `foo/bar_baz/x`. List is not recursive, i.e. `foo/bar/more/x`
199-
will not be included.
198+
`foo/bar/x` but not of `foo/bar_baz/x`. This list is not recursive, i.e. `foo/bar/more/x` will **not** be included.
199+
200+
!!! note
201+
Any prefix supplied to this `prefix` parameter will **not** be stripped off the
202+
paths in the result.
200203
201204
Args:
202205
store: The ObjectStore instance to use.

0 commit comments

Comments
 (0)