-
Notifications
You must be signed in to change notification settings - Fork 83
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
Deprecate IntoReport::report
in favor of IntoReport::into_report
#698
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We wanted to keep breaking-changes to a minimum, but I'm guessing this is going to be released in the same version as #697 which needs breaking changes anyway? If so then I'm good with this, let me know and I'll approve
Yes, I expect it to be the same release. Also, it's currently only deprecated so that the users code won't break. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I appreciate we usually want to deprecate first and leave it for a few versions, but perhaps we want to remove it now because we're already forcing a major version?
Unsure about that as replacing the import statement is easier than replacing every function signature. Also, the breaking changes currently only apply to the nightly toolchain if the |
I hadn't thought about the fact that the breaking change applied to nightly only (and only if used). I agree, let's mark as deprecated for a few versions then 👍 |
🌟 What is the purpose of this PR?
report()
could be misleading because of two reasons:Report
based on the current Result but consuming itreport()
on theTermination
trait defined in std (which also leads to annoying auto-import issues in IDEs)🔍 What does this change?
IntoReport::into_report
IntoReport::report
in favor ofIntoReport::into_report