Fix docs for OsStr#47357

whentze · 2018-01-11T16:43:01Z

At present, there are two small issues with the docs for std::ffi::OsStr:

The docs say "OsStr is to OsString as String is to &str: the former in each pair are borrowed references; the latter are owned strings.". The latter pair is mixed up: String is the owned variant whereas &str is the borrowed reference.
The doc links to String and &str are broken and render as [String] and [&str].

This PR fixes these issues.

rust-highfive · 2018-01-11T16:43:13Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

Mark-Simulacrum · 2018-01-11T17:32:41Z

r? @GuillaumeGomez

Diggsey · 2018-01-11T18:31:25Z

src/libstd/ffi/os_str.rs

 /// representation.
 ///
-/// `OsStr` is to [`OsString`] as [`String`] is to [`&str`]: the former in each pair are borrowed
+/// `OsStr` is to [`OsString`] as [`&str`] is to [`String`]: the former in each pair are borrowed


This should either be &OsStr and &str or OsStr and str

GuillaumeGomez · 2018-01-11T19:28:56Z

All good except @Diggsey's comment. Please fix it and then r=me.

whentze · 2018-01-11T21:10:55Z

r? @GuillaumeGomez

GuillaumeGomez · 2018-01-12T11:15:21Z

Thanks!

@bors: r+ rollup

bors · 2018-01-12T11:15:22Z

📌 Commit 8002876 has been approved by GuillaumeGomez

…omez Fix docs for OsStr At present, there are two small issues with the [docs](https://doc.rust-lang.org/std/ffi/struct.OsStr.html) for std::ffi::OsStr: - The docs say "OsStr is to OsString as String is to &str: the former in each pair are borrowed references; the latter are owned strings.". The latter pair is mixed up: String is the owned variant whereas &str is the borrowed reference. - The doc links to String and &str are broken and render as [String] and [&str]. This PR fixes these issues.

Rollup of 24 pull requests - Successful merges: #46985, #47069, #47081, #47185, #47282, #47283, #47288, #47289, #47298, #47305, #47306, #47307, #47310, #47324, #47328, #47331, #47340, #47343, #47344, #47352, #47357, #47365, #47375, #47382 - Failed merges: #47334

whentze added 2 commits January 11, 2018 17:20

Fix confusing documentation for OsStr

fc825f0

Fix dead links in docs for OsStr

bac725e

rust-highfive assigned Mark-Simulacrum Jan 11, 2018

rust-highfive assigned GuillaumeGomez and unassigned Mark-Simulacrum Jan 11, 2018

kennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 11, 2018

Diggsey reviewed Jan 11, 2018

View reviewed changes

s/OsStr/&OsStr in docs to align with &str/String comparison

8002876

kennytm mentioned this pull request Jan 12, 2018

Rollup of 24 pull requests #47392

Merged

bors merged commit 8002876 into rust-lang:master Jan 12, 2018

whentze deleted the osstr-doc-fix branch January 13, 2018 16:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix docs for OsStr#47357