Bury Error::description() #2230

kornelski · 2017-11-29T16:46:25Z

nagisa · 2017-11-29T16:50:57Z

durka · 2017-11-29T17:35:55Z

0000-bury-description.md

+# Drawbacks
+[drawbacks]: #drawbacks
+
+When users start omitting bespoke `description()` implementations, code that still uses this method will get machine-generated rather than human-written descriptions, so success of this change depends also on steering authors away from using this method as well.


Why not also formally deprecate the method?

It could create too many warnings. Perhaps it would be OK to do it after a while?

Some projects may still like using a static string for description. I'm concerned about saving time users who don't want to use it, but don't want to get in the way of users who still want it.

I would like to see the method formally deprecated at some point, but I agree that we should give it several releases before doing so, and make sure it has minimal impact on the ecosystem.

+1 for eventual formal deprecation

jnicholls · 2017-11-30T02:19:30Z

Totally agree on making this method optional/transparent/forgotten/deprecated/dismissed/booted/chopped/kicked/etc.

aturon · 2018-02-14T07:06:09Z

@withoutboats can you shepherd this RFC?

withoutboats · 2018-02-14T07:24:35Z

Why not deprecate it also?

Centril · 2018-02-14T07:31:52Z

@withoutboats It might be just me... but .description() seems like a cheap way to describe error enums with unit-only-variants... There's always Debug, but a &str is cheaper..

To make .description() a bit more useful you could perhaps make it derivable?

sfackler · 2018-02-14T17:11:02Z

@Centril can you point to some code that uses description in that way?

Centril · 2018-02-14T17:15:20Z

@sfackler Not really; If you have such a unit-variant enum, then I guess you can use an inherent method instead - the bound isn't important wrt. .description() here, and neither as a trait object.

Mark-Simulacrum · 2018-04-20T15:31:03Z

0000-bury-description.md

+# Reference-level explanation
+[reference-level-explanation]: #reference-level-explanation
+
+The description method can have default implementation returning `core::intrinsics::type_name::<Self>()`. This preserves basic functionality of this method for backwards compatibility.


Are we comfortable somewhat stabilizing type_name? This makes it at least somewhat easy to (abuse) this to get it's functionality on stable for non-error types in at least binaries where the impl of Error doesn't matter too much from an exposed API perspective.

Either way, we should explicitly state that this method's default return value is not stable and should not be relied on from version to version.

Simon's current PR just returns ""

rust-lang/rfcs#2230

U007D · 2018-04-20T15:52:24Z

Overall, I like this. Although I'm not sure why we'd steer people away from implementing .description() in documentation and not officially deprecate it. The rationale given:

... this RFC does not propose formal deprecation at this time to avoid unnecessary warnings during the transition.

would seem to apply any time any feature is deprecated, no? The above-mentioned warning would also serve to reinforce the updated documentation, essentially ensuring discovery.

Overall, things are currently a bit messier than I think we'd all like around errors and error handling--moving as swiftly as we can (but not recklessly) seems to me to be a good way to realizing the full potential of Rust's error handling--to that end, I'd (also) support official deprecation of .description().

Procedural question: Should I review with "change requested", or just leave this feedback as it is?

repax · 2018-04-20T21:48:16Z

I would like description() to be deprecated, or at least just return "". I think it's undesirable to expose identifier names (which are just source-code level entities).

The identifier name of a type should not have any consequence on its public output/effect - especially not by default.

kornelski · 2018-04-21T03:25:09Z

What should the default message be? Type name is out. Empty string is out.

repax · 2018-04-21T08:29:13Z

Is is out of the question to have different outputs depending on whether dbg_print is enabled? If enabled, a more detailed description could be provided by the compiler, and if not a minimal default would be used. The developer can always add his/her own implementation, if necessary.

The default output for both the dbg_print and the non-dbg_print case could simply be left unspecified. That should be compatible with the current situation.

kornelski · 2018-04-21T11:42:42Z

I'm thinking about making the message push authors towards switching to Display instead, so "description is deprecated" or "use Display instead" or "https://rust-lang.org/how-to-fix-descriptions"

U007D · 2018-04-21T13:25:37Z

Hmm.. this is tricky! :)

".description() is deprecated--see https://rust-lang.org/how-to-fix-description" (along with explanatory content at that address) seems to be a reasonable default message to me, given the excellent points made by @repax and @Mark-Simulacrum. (Suggest singular 'description' in URL)

Bury Error::description() Second attempt of #49536 rust-lang/rfcs#2230 The exact wording of the default implementation is still up in the air, but I think it's a detail that can be amended later.

kornelski · 2018-04-30T17:47:27Z

the implementation is merged!

U007D · 2018-04-30T18:17:46Z

0000-bury-description.md

+# Drawbacks
+[drawbacks]: #drawbacks
+
+When users start omitting bespoke `description()` implementations, code that still uses this method will start getting empty strings instead of human-written description. If this becomes a problem, the `description()` method can also be formally deprecated (with the `#[deprecated]` attribute). However, there's no urgency to remove existing implementations of `description()`, so this RFC does not propose formal deprecation at this time to avoid unnecessary warnings during the transition.


...code that still uses this method will start getting empty strings instead of human-written description

No longer--the implementation merged into master now returns "description() is deprecated; use Display" as a default message.

Suggest: s/empty strings/.description() deprecated message

U007D · 2018-04-30T22:53:48Z

I have no power... :)

alexcrichton · 2018-05-03T01:16:50Z

It turns out that the implementation for this RFC has already merged! In light of that I'm going to go ahead and merge the RFC

Bury Error::description()

98a5691

dtolnay added the T-libs-api Relevant to the library API team, which will review and decide on the RFC. label Nov 29, 2017

kornelski mentioned this pull request Nov 29, 2017

Provide better guidance for Error::description rust-lang/rust#45249

Closed

durka reviewed Nov 29, 2017

View reviewed changes

Note possibility of later deprecation

d340931

CAD97 mentioned this pull request Dec 18, 2017

nom4: the trait std::error::Error is not implemented for nom::internal::Err<&[u8]> rust-bakery/nom#591

Closed

aturon assigned withoutboats Feb 14, 2018

SimonSapin mentioned this pull request Apr 15, 2018

Soft-deprecate the description() method of the Error trait rust-lang/rust#49536

Closed

Mark-Simulacrum reviewed Apr 20, 2018

View reviewed changes

kornelski added a commit to kornelski/book that referenced this pull request Apr 20, 2018

Remove mentions of Error::description()

e0352f1

rust-lang/rfcs#2230

Make deprecated description return empty string

a15b80f

kornelski mentioned this pull request Apr 22, 2018

Bury Error::description() rust-lang/rust#50163

Merged

U007D requested changes Apr 30, 2018

View reviewed changes

Update RFC to match implementation

01434ea

U007D approved these changes Apr 30, 2018

View reviewed changes

alexcrichton merged commit 01434ea into rust-lang:master May 3, 2018

Centril added A-traits-libstd Standard library trait related proposals & ideas A-error-handling Proposals relating to error handling. labels Nov 23, 2018

jeff1010322 mentioned this pull request Jul 1, 2019

Rust Documentation added and code cleanup kochavalabs/mazzaroth-rs#20

Merged

antonok-edm mentioned this pull request Feb 12, 2020

Remove deprecated method Error::description brave/adblock-rust#74

Merged

Skaldebane mentioned this pull request Mar 24, 2023

Error::description() deprecated, should use Display trait giovanniberti/robusta#25

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bury Error::description() #2230

Bury Error::description() #2230

kornelski commented Nov 29, 2017 •

edited by Centril

Loading

nagisa commented Nov 29, 2017

durka Nov 29, 2017

kornelski Nov 29, 2017

joshtriplett Nov 30, 2017

U007D Dec 1, 2017

jnicholls commented Nov 30, 2017

aturon commented Feb 14, 2018

withoutboats commented Feb 14, 2018

Centril commented Feb 14, 2018

sfackler commented Feb 14, 2018

Centril commented Feb 14, 2018

Mark-Simulacrum Apr 20, 2018

kornelski Apr 20, 2018

U007D commented Apr 20, 2018 •

edited

Loading

repax commented Apr 20, 2018

kornelski commented Apr 21, 2018 •

edited

Loading

repax commented Apr 21, 2018

kornelski commented Apr 21, 2018

U007D commented Apr 21, 2018 •

edited

Loading

kornelski commented Apr 30, 2018 •

edited

Loading

U007D Apr 30, 2018 •

edited

Loading

U007D commented Apr 30, 2018

alexcrichton commented May 3, 2018

Bury Error::description() #2230

Bury Error::description() #2230

Conversation

kornelski commented Nov 29, 2017 • edited by Centril Loading

nagisa commented Nov 29, 2017

durka Nov 29, 2017

Choose a reason for hiding this comment

kornelski Nov 29, 2017

Choose a reason for hiding this comment

joshtriplett Nov 30, 2017

Choose a reason for hiding this comment

U007D Dec 1, 2017

Choose a reason for hiding this comment

jnicholls commented Nov 30, 2017

aturon commented Feb 14, 2018

withoutboats commented Feb 14, 2018

Centril commented Feb 14, 2018

sfackler commented Feb 14, 2018

Centril commented Feb 14, 2018

Mark-Simulacrum Apr 20, 2018

Choose a reason for hiding this comment

kornelski Apr 20, 2018

Choose a reason for hiding this comment

U007D commented Apr 20, 2018 • edited Loading

repax commented Apr 20, 2018

kornelski commented Apr 21, 2018 • edited Loading

repax commented Apr 21, 2018

kornelski commented Apr 21, 2018

U007D commented Apr 21, 2018 • edited Loading

kornelski commented Apr 30, 2018 • edited Loading

U007D Apr 30, 2018 • edited Loading

Choose a reason for hiding this comment

U007D commented Apr 30, 2018

alexcrichton commented May 3, 2018

kornelski commented Nov 29, 2017 •

edited by Centril

Loading

U007D commented Apr 20, 2018 •

edited

Loading

kornelski commented Apr 21, 2018 •

edited

Loading

U007D commented Apr 21, 2018 •

edited

Loading

kornelski commented Apr 30, 2018 •

edited

Loading

U007D Apr 30, 2018 •

edited

Loading