docs: inline std::ffi::c_str types to std::ffi
#134791
Merged
+7
−7
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
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.
rustbot
added
S-waiting-on-review
notriddle
added
the
beta-nominated
|
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
added
S-waiting-on-bors
bors
added
S-waiting-on-author
|
@bors r=tgross35 |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 27, 2024
Rollup of 8 pull requests Successful merges: - rust-lang#131522 ([macro_metavar_expr_concat] Fix rust-lang#128346) - rust-lang#134379 (Add `into_array` conversion destructors for `Box`, `Rc`, and `Arc`.) - rust-lang#134644 (Document collection `From` and `FromIterator` impls that drop duplicate keys.) - rust-lang#134649 (Fix forgetting to save statx availability on success) - rust-lang#134728 (Use scoped threads in `std::sync::Barrier` examples) - rust-lang#134782 (Update Code Example for `Iterator::rposition`) - rust-lang#134789 (unwinding: bump version to fix naked_asm on Xous) - rust-lang#134791 (docs: inline `std::ffi::c_str` types to `std::ffi`) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 27, 2024
Rollup merge of rust-lang#134791 - notriddle:notriddle/inline-ffi-error-types, r=tgross35 docs: inline `std::ffi::c_str` types to `std::ffi` 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. Fixes rust-lang#134702 r? `@tgross35`
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.
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