docstore: Clarify docs for nested field paths #3511
Merged
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
jba
approved these changes
Nov 25, 2024
docstore/doc.go
Outdated
| // the nested struct field or map key. For nested slices, some providers (notably | ||
| // MongoDB) treat s.f, where s is a sequence, as the slice of e.f for each e in s. | ||
| // However, others do not support field selectors inside slices. If you need fully | ||
| // portable code, you cannot rely on this feature. |
There was a problem hiding this comment.
We ended up not merging the PR, so I would say: "However, others do not support field selectors inside slices, so docstore does not support them."
There was a problem hiding this comment.
Sorry, I hadn't seen your comment on the bug. I think this should say we don't support it, but then the memdocstore option should explain that it's not portable and will only work on mongodb.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3511 +/- ##
=======================================
Coverage 73.24% 73.24%
=======================================
Files 113 113
Lines 15052 15052
=======================================
Hits 11025 11025
Misses 3262 3262
Partials 765 765 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
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.
Updates #3506.