Add documentation on str::starts_with
#120764
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
Add documentation about a current footgun of `str::starts_with`
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
m-ou-se
reviewed
Feb 8, 2024
library/core/src/str/mod.rs
Outdated
Comment on lines
1163
to
1167
| /// Note that there is a footgun to this method when using a slice of [`char`]s. | ||
| /// Some users may expect that a slice of chars will behave similarly to a `&str` with this method. | ||
| /// That is not currently the case. When you pass a slice of [`char`]s to this method, it will return true | ||
| /// if any of the [`char`]s in the slice is the first [`char`] of this string slice. It does not work for | ||
| /// sequentially comparing a slice of [`char`]s to a string slice. See the second example below. |
There was a problem hiding this comment.
I don't think this wording (with "footgun", "some users", "currently", etc.) is very useful.
How about instead just adding a bit more detail to the paragraph above? Maybe something in this direction?
- /// The [pattern] can be a `&str`, [`char`], a slice of [`char`]s, or a
- /// function or closure that determines if a character matches.
+ /// The [pattern] can be a `&str` to check for a prefix,
+ /// or a [`char`], slice of [`char`]s, or function or closure
+ /// to check the first character for a match.
m-ou-se
added
S-waiting-on-author
|
@m-ou-se how does that look? |
rustbot
added
S-waiting-on-review
|
Thanks! @bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 10, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#117614 (static mut: allow mutable reference to arbitrary types, not just slices and arrays) - rust-lang#120719 (Remove support for `associated_type_bound` nested in `dyn` types) - rust-lang#120764 (Add documentation on `str::starts_with`) - rust-lang#120823 (Clarify that atomic and regular integers can differ in alignment) - rust-lang#120859 (Loosen an assertion to account for stashed errors.) - rust-lang#120865 (Turn the "no saved object file in work product" ICE into a translatable fatal error) - rust-lang#120866 (Remove unnecessary `#![feature(min_specialization)]`) - rust-lang#120870 (Allow restricted trait impls under `#[allow_internal_unstable(min_specialization)]`) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 10, 2024
Rollup merge of rust-lang#120764 - Alfriadox:master, r=m-ou-se Add documentation on `str::starts_with` Add documentation about a current footgun of `str::starts_with`
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.
Add documentation about a current footgun of
str::starts_with