nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-21 22:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #129963 - rjooske:fix/inaccurate_to_string_lossy_doc, r=workingjubilee

Browse Source 
Inaccurate `{Path,OsStr}::to_string_lossy()` documentation

The documentation of `Path::to_string_lossy()` and `OsStr::to_string_lossy()` says the following:
> Any non-Unicode sequences are replaced with `U+FFFD REPLACEMENT CHARACTER`

which didn't immediately make sense to me. ("non-Unicode sequences"?)
Since both `to_string_lossy` functions eventually become just a call to `String::from_utf8_lossy`, I believe the documentation meant to say:
> Any *non-UTF-8* sequences are replaced with `U+FFFD REPLACEMENT CHARACTER`

This PR corrects this mistake in the documentation.

For the record, a similar quote can be found in the documentation of `String::from_utf8_lossy`:
> ... During this conversion, `from_utf8_lossy()` will replace any invalid UTF-8 sequences with `U+FFFD REPLACEMENT CHARACTER`, ...
This commit is contained in:
Matthias Krüger 2024-09-06 07:33:57 +02:00 committed by GitHub
commit 45d6957f24
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
library/std/src/ffi/os_str.rs
View File

@ -852,7 +852,7 @@ impl OsStr {
/// Converts an `OsStr` to a <code>[Cow]<[str]></code>. /// Converts an `OsStr` to a <code>[Cow]<[str]></code>.
/// ///
/// Any non-Unicode sequences are replaced with /// Any non-UTF-8 sequences are replaced with
/// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD]. /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
/// ///
/// [U+FFFD]: crate::char::REPLACEMENT_CHARACTER /// [U+FFFD]: crate::char::REPLACEMENT_CHARACTER

2
library/std/src/path.rs
View File

@ -2200,7 +2200,7 @@ impl Path {
/// Converts a `Path` to a [`Cow<str>`]. /// Converts a `Path` to a [`Cow<str>`].
/// ///
/// Any non-Unicode sequences are replaced with /// Any non-UTF-8 sequences are replaced with
/// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD]. /// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
/// ///
/// [U+FFFD]: super::char::REPLACEMENT_CHARACTER /// [U+FFFD]: super::char::REPLACEMENT_CHARACTER