Improve comments of iterate_upper_bound #8331
Closed
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
Summary: ReadOptions.iterate_upper_bound's comment is confusing. Improve it.
|
@siying has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
jay-zhuang
approved these changes
May 26, 2021
adamretter
reviewed
May 26, 2021
| // not a valid entry. If prefix_extractor is not null, the Seek target | ||
| // and iterate_upper_bound need to have the same prefix. | ||
| // This is because ordering is not guaranteed outside of prefix domain. | ||
| // not a valid entry. If prefix_extractor is not null: |
There was a problem hiding this comment.
I suggest some small language changes:
// not a valid entry. If prefix_extractor is not null:
// 1. If options.auto_prefix_mode = true, iterate_upper_bound will be used
// to infer the prefix to use with the seek key.
// 2. If options.auto_prefix_mode = false, iterate_upper_bound only takes
// effect if it shares the same prefix as the seek key. If
// iterate_upper_bound is outside the prefix of the seek key, then keys returned outside
// the prefix range will be undefined, just as if iterate_upper_bound = null.
// If iterate_upper_bound is not null, SeekToLast() will position the iterator
// at the first key smaller than iterate_upper_bound.
|
@siying has updated the pull request. You must reimport the pull request before landing. |
|
@siying has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
|
@siying has updated the pull request. You must reimport the pull request before landing. |
|
@siying has updated the pull request. You must reimport the pull request before landing. |
|
@siying has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
|
This pull request has been merged in dfa6b40. |
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.
Summary: ReadOptions.iterate_upper_bound's comment is confusing. Improve it.