Hide Error::description and cause methods #66859
Closed
Conversation
This file contains hidden or 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
Description has been documented as soft-deprecated since 1.27.0, cause has been documented as deprecated since 1.30.0 and has produced deprecation warnings since 1.33.0. There is no longer any reason to call or implement either of these methods. Now it's a year or a year and a half later and there is less and less reason over time to even know about either one. This commit adds #[doc(hidden)] to Error::description and Error::cause to keep them out of the standard library's API documentation.
dtolnay
added
the
T-libs-api
|
r? @Kimundi (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
@rfcbot poll @rust-lang/libs hide them? |
|
Team member @dtolnay has asked teams: T-libs, for consensus on:
|
|
Shouldn't we actually-deprecate description? I don't really like hiding deprecated APIs - it just makes things confusing when you're trying to figure out where some method comes from. |
|
Okay that's fair -- I opened #66919 as an alternative which keeps them visible. |
|
@Amanieu @Kimundi @KodrAus @sfackler @withoutboats waiting for your consensus on the poll above |
|
I think another solution is preferred in #66919 @Dylan-DPC |
|
Closing this because #66919 is in FCP and is the clear preference of the libs team |
dtolnay
added
A-error-handling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
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.
descriptionhas been documented as soft-deprecated since 1.27.0,causehas been documented as deprecated since 1.30.0 and has produced deprecation warnings since 1.33.0. There is no longer any reason to call or implement either of these methods. Now it's a year or a year and a half later and there is less and less reason over time to even know about either one.This commit adds
#[doc(hidden)]toError::descriptionandError::causeto keep them out of the standard library's API documentation.