Fix a few documentation errors including in public APIs #9789
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
|
@ajkr has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
riversand963
approved these changes
Apr 1, 2022
| // kTypeBeginPrepareXID varstring | ||
| // kTypeEndPrepareXID | ||
| // kTypeBeginPrepareXID | ||
| // kTypeEndPrepareXID varstring |
There was a problem hiding this comment.
Could you add an entry for kTypeCommitXIDAndTimestamp varstring varstring? Thanks!
include/rocksdb/db.h
Outdated
| // returned are in the order of insertion. | ||
| // merge_operands- Points to an array of at-least | ||
| // Assigns all the merge operands corresponding to the key to the | ||
| // `merge_operands` array. Upon success, the number of merge operands set is |
There was a problem hiding this comment.
Is "number of merge operands set" a typo?
There was a problem hiding this comment.
Rewrote to try to make it clearer.
|
@ajkr has updated the pull request. You must reimport the pull request before landing. |
ajkr
commented
Apr 1, 2022
| // kTypeBeginPrepareXID varstring | ||
| // kTypeEndPrepareXID | ||
| // kTypeBeginPrepareXID | ||
| // kTypeEndPrepareXID varstring |
include/rocksdb/db.h
Outdated
| // returned are in the order of insertion. | ||
| // merge_operands- Points to an array of at-least | ||
| // Assigns all the merge operands corresponding to the key to the | ||
| // `merge_operands` array. Upon success, the number of merge operands set is |
There was a problem hiding this comment.
Rewrote to try to make it clearer.
|
@ajkr has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
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.
The internal WriteBatch doc wrongly indicated which optypes are followed by varstring. Updated some optypes according to the following code:
rocksdb/db/write_batch.cc
Lines 418 to 429 in 76383be
The
Iterator::Refresh()+DeleteRange()bug was fixed in #9258; removed the warnings.GetMergeOperands()does populate*number_of_operandsincluding upon successful return:rocksdb/db/db_impl/db_impl.cc
Lines 1917 to 1919 in 76383be