object_store: Clarify what is a prefix in list() documentation #6520
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It should be obvious to reader that `foo/bar/` is not a prefix of `foo/bar_baz`, because it is true whether they think in term of strings, S3-like API paths, or POSIX-like paths. What is less clear is that `foo/bar` is also not a prefix of `foo/bar_baz`, because this is not true with strings or S3-like API paths, only of POSIX-like paths. Additionally, the definition of paths (https://docs.rs/object_store/0.11.0/object_store/path/struct.Path.html) says that paths cannot have a trailing `/`.
tustvold
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
none, this is a very small change
Rationale for this change
It should be obvious to reader that
foo/bar/is not a prefix offoo/bar_baz, because it is true whether they think in term of strings, S3-like API paths, or POSIX-like paths.What is less clear is that
foo/baris also not a prefix offoo/bar_baz, because this is not true with strings or S3-like API paths, only of POSIX-like paths.Additionally, the definition of paths
(https://docs.rs/object_store/0.11.0/object_store/path/struct.Path.html) says that paths cannot have a trailing
/.What changes are included in this PR?
Replace the
foo/bar/example prefix withfoo/barAre there any user-facing changes?
only the documentation