Skip to content

Conversation

david-perez
Copy link
Contributor

In commit 29403ee, documentation for the methods on std::any::Any was
modified so that they referred to the concrete value behind the trait
object as the "inner" value. This is a more accurate wording than
"boxed": while putting trait objects inside boxes is arguably the most
common use, they can also be placed behind other pointer types like
&mut or std::sync::Arc.

This commit does the same documentation changes for std::error::Error.

In commit 29403ee, documentation for the methods on `std::any::Any` was
modified so that they referred to the concrete value behind the trait
object as the "inner" value. This is a more accurate wording than
"boxed": while putting trait objects inside boxes is arguably the most
common use, they can also be placed behind other pointer types like
`&mut` or `std::sync::Arc`.

This commit does the same documentation changes for `std::error::Error`.
@rust-highfive
Copy link
Contributor

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.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 10, 2022
@camelid camelid added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Jan 10, 2022
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jan 10, 2022

📌 Commit 5786bbd has been approved by Mark-Simulacrum

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 10, 2022
Copy link

@mkbhanda mkbhanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 11, 2022
…-std-error, r=Mark-Simulacrum

Eliminate "boxed" wording in `std::error::Error` documentation

In commit 29403ee, documentation for the methods on `std::any::Any` was
modified so that they referred to the concrete value behind the trait
object as the "inner" value. This is a more accurate wording than
"boxed": while putting trait objects inside boxes is arguably the most
common use, they can also be placed behind other pointer types like
`&mut` or `std::sync::Arc`.

This commit does the same documentation changes for `std::error::Error`.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 11, 2022
…-std-error, r=Mark-Simulacrum

Eliminate "boxed" wording in `std::error::Error` documentation

In commit 29403ee, documentation for the methods on `std::any::Any` was
modified so that they referred to the concrete value behind the trait
object as the "inner" value. This is a more accurate wording than
"boxed": while putting trait objects inside boxes is arguably the most
common use, they can also be placed behind other pointer types like
`&mut` or `std::sync::Arc`.

This commit does the same documentation changes for `std::error::Error`.
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 12, 2022
…askrgr

Rollup of 14 pull requests

Successful merges:

 - rust-lang#92328 (Tweak sentence in `transmute` docs)
 - rust-lang#92432 (Error when selected impl is not const in constck)
 - rust-lang#92506 (Document Box<T> FFI guarantee in 1.41.0 release notes)
 - rust-lang#92699 (rustdoc: Display "private fields" instead of "fields omitted")
 - rust-lang#92703 (RELEASES.md: Add 1.58 release note for `File::options` stabilization)
 - rust-lang#92707 (Extended the note on the use of `no_run` attribute)
 - rust-lang#92709 (Improve documentation for File::options to give a more likely example)
 - rust-lang#92720 (Fix doc formatting for time.rs)
 - rust-lang#92732 (Add note about upstream commit musl-patch-configure.diff is derived from)
 - rust-lang#92742 (Add missing suffix for sidebar-items script path)
 - rust-lang#92748 (Eliminate "boxed" wording in `std::error::Error` documentation)
 - rust-lang#92754 (Update AsmArgs field visibility for rustfmt)
 - rust-lang#92756 (:arrow_up: rust-analyzer)
 - rust-lang#92764 (Fix rust logo style)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 286bb18 into rust-lang:master Jan 12, 2022
@rustbot rustbot added this to the 1.60.0 milestone Jan 12, 2022
@david-perez david-perez deleted the eliminate-boxed-wording-std-error branch January 13, 2022 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants