Documentation update to map.rs as part of tracking issue #107540#154513
Open
KaiPetzke wants to merge 1 commit intorust-lang:mainfrom
Open
Documentation update to map.rs as part of tracking issue #107540#154513KaiPetzke wants to merge 1 commit intorust-lang:mainfrom
KaiPetzke wants to merge 1 commit intorust-lang:mainfrom
Conversation
As Part of tracking issue rust-lang#107540, I submit a comment fix (the comments describing the method CursorMut::insert_after_unchecked() should say "before" instead of "after". This can be seen for example from the comments for CursorMutKey::insert_after_unchecked(), which are correct. I further submit a suggestion to make the comments before all Cursor insert methods slightly more verbose to explain the before/after in the names of those methods: insert_after() inserts the new item effectively after the cursor, thus positioning the cursor itself before the new element. I hope the extra verbosity will help to clarify the actual behavior of these methods. No actual code is updated.
rustbot
added
S-waiting-on-review
Collaborator
|
rustbot has assigned @Mark-Simulacrum. Use Why was this reviewer chosen?The reviewer was selected based on:
|
Collaborator
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
As Part of tracking issue #107540, I submit a document fix (the comments describing the method
CursorMut::insert_after_unchecked()should say "before" instead of "after". This can be seen for example from the comments forCursorMutKey::insert_after_unchecked(), which are correct.I further submit a suggestion to make the comments before all Cursor insert methods slightly more verbose to explain the before/after in the names of those methods: insert_after() inserts the new item effectively after the cursor, thus positioning the cursor itself before the new element. I hope the extra verbosity will help to clarify the actual behavior of these methods.
No actual code is updated.