Skip to content
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

std::error::Error trait doc still talks about cause() #57056

Closed
Arnavion opened this issue Dec 22, 2018 · 0 comments
Closed

std::error::Error trait doc still talks about cause() #57056

Arnavion opened this issue Dec 22, 2018 · 0 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools P-medium Medium priority

Comments

@Arnavion
Copy link

rust/src/libstd/error.rs

Lines 43 to 48 in a9ff135

/// The [`cause`] method is generally used when errors cross "abstraction
/// boundaries", i.e., when a one module must report an error that is "caused"
/// by an error from a lower-level module. This setup makes it possible for the
/// high-level module to provide its own errors that do not commit to any
/// particular implementation, but also reveal some of its implementation for
/// debugging via [`cause`] chains.

This should be updated to talk about source() instead.

@sfackler sfackler added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Dec 22, 2018
@steveklabnik steveklabnik added the P-medium Medium priority label Dec 27, 2018
Centril added a commit to Centril/rust that referenced this issue Jan 12, 2019
…ource, r=wesleywiser

Change std::error::Error trait documentation to talk about `source` instead of `cause`

Resolves rust-lang#57056
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools P-medium Medium priority
Projects
None yet
Development

No branches or pull requests

3 participants