-
Notifications
You must be signed in to change notification settings - Fork 14.1k
docs: inline std::ffi::c_str types to std::ffi
#134791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: inline std::ffi::c_str types to std::ffi
#134791
Conversation
Rustdoc has no way to show that an item is stable, but only at a different path. `std::ffi::c_str::NulError` is not stable, but `std::ffi::NulError` is. To avoid marking these types as unstable when someone just wants to follow a link from `CString`, inline them into their stable paths.
|
Nominating for beta because the risk is low and the docs are very misleading in their current form. |
|
Thanks for fixing this. @bors r+ rollup |
|
@bors r=tgross35 |
|
@GuillaumeGomez Should we beta nominate this so that it shows up in the Zulip channel? |
|
Yes please. Go ahead :) |
|
How do I do that? Adding the label didn't seem to work. |
|
Hum weird, normally just putting the label is supposed to do it... |
|
@Kobzol Did the way to nominate beta backport changed? |
|
Note that #134851 is also nominated, same change to a different module. |
|
I just want to double check, @clarfonthey it looks like you marked these |
I don't think so, but I don't actually know how it worked before 🤷 |
Main reason was just that rustdoc always inlines cross-crate exports and I wanted to make it clearer that these are part of the |
Rustdoc has no way to show that an item is stable, but only at a different path.
std::ffi::c_str::NulErroris not stable, butstd::ffi::NulErroris.To avoid marking these types as unstable when someone just wants to follow a link from
CString, inline them into their stable paths.Fixes #134702
r? @tgross35