Skip to content
This repository has been archived by the owner on Aug 12, 2021. It is now read-only.

Commit

Permalink
Rename fail! to panic!
Browse files Browse the repository at this point in the history
rust-lang/rfcs#221

The current terminology of "task failure" often causes problems when
writing or speaking about code. You often want to talk about the
possibility of an operation that returns a Result "failing", but cannot
because of the ambiguity with task failure. Instead, you have to speak
of "the failing case" or "when the operation does not succeed" or other
circumlocutions.

Likewise, we use a "Failure" header in rustdoc to describe when
operations may fail the task, but it would often be helpful to separate
out a section describing the "Err-producing" case.

We have been steadily moving away from task failure and toward Result as
an error-handling mechanism, so we should optimize our terminology
accordingly: Result-producing functions should be easy to describe.

To update your code, rename any call to `fail!` to `panic!` instead.
Assuming you have not created your own macro named `panic!`, this
will work on UNIX based systems:

    grep -lZR 'fail!' . | xargs -0 -l sed -i -e 's/fail!/panic!/g'

You can of course also do this by hand.

[breaking-change]
  • Loading branch information
steveklabnik committed Oct 29, 2014
1 parent e4527b0 commit 93ba269
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion terminfo/parm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ impl FormatOp {
'x' => FormatHex,
'X' => FormatHEX,
's' => FormatString,
_ => fail!("bad FormatOp char")
_ => panic!("bad FormatOp char")
}
}
fn to_char(self) -> char {
Expand Down

0 comments on commit 93ba269

Please sign in to comment.