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

Clarify when panic cases need to be documented #85

Closed
dtolnay opened this Issue May 31, 2017 · 1 comment

Comments

Projects
None yet
1 participant
@dtolnay
Copy link
Member

dtolnay commented May 31, 2017

For instance, this seems silly:

/// # Panics
///
/// This function panics if `T`'s implementation of `Display` panics.
pub fn print<T: Display>(t: T) {
    println!("{}", t.to_string());
}
@dtolnay

This comment has been minimized.

Copy link
Member Author

dtolnay commented Oct 29, 2017

Added in 4c0e9fb.

@dtolnay dtolnay closed this Oct 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.