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

Rename task failure to task panic #17489

Closed
alexcrichton opened this issue Sep 23, 2014 · 11 comments
Closed

Rename task failure to task panic #17489

alexcrichton opened this issue Sep 23, 2014 · 11 comments
Assignees
Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented.
Milestone

Comments

@alexcrichton
Copy link
Member

Tracking issue for rust-lang/rfcs#221

Nominating, as renaming the fail! macro to panic! is backwards incompatible. I believe updating all the documentation does not necessarily need to block 1.0.

@alexcrichton alexcrichton added I-nominated B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented. labels Sep 23, 2014
@mdinger
Copy link
Contributor

mdinger commented Sep 24, 2014

Can't you just do this to update everything immediately? I'm not sure why the documentation would lag since it would be updated as well...

$ cd rust-src/dir
$ grep -lZR 'fail!' . | xargs -0 -l sed -i -e 's/fail!/panic!/g'

@huonw
Copy link
Member

huonw commented Sep 24, 2014

@mdinger our documentation has things like "This fails if ...", and # Failure. (Most refer to fail!, but some refer to the general idea of "this operation may not succeed".)

@mdinger
Copy link
Contributor

mdinger commented Sep 24, 2014

Ah, I see

@pnkfelix
Copy link
Member

1.0, P-backcompat-libs.

@pnkfelix pnkfelix added this to the 1.0 milestone Sep 25, 2014
@aturon
Copy link
Member

aturon commented Sep 25, 2014

@steveklabnik It would be good to coordinate the (easy) code change with the (harder) doc change. Do you have any thoughts here?

@steveklabnik
Copy link
Member

Sure, want me to just do all of it? The code part should be pretty easy too.

@aturon
Copy link
Member

aturon commented Oct 9, 2014

@steveklabnik Sure, that'd be awesome!

One thing we should do as part of this is standardize the the markdown subsection for describing error outcomes. Let's talk about that on IRC when you get the chance.

@aturon
Copy link
Member

aturon commented Oct 9, 2014

@steveklabnik Just to be clear, the documentation change means not just the guide, but also all of the doc comments in libstd.

@steveklabnik
Copy link
Member

Yup.

@steveklabnik steveklabnik self-assigned this Oct 9, 2014
bors added a commit that referenced this issue Oct 29, 2014
This in-progress PR implements #17489.

I made the code changes in this commit, next is to go through alllllllll the documentation and fix various things.

- Rename column headings as appropriate, `# Panics` for panic conditions and `# Errors` for `Result`s.
- clean up usage of words like 'fail' in error messages

Anything else to add to the list, @aturon ? I think I should leave the actual functions with names like `slice_or_fail` alone, since you'll get to those in your conventions work?

I'm submitting just the code bits now so that we can see it separately, and I also don't want to have to keep re-building rust over and over again if I don't have to 😉 

Listing all the bits so I can remember as I go:

- [x] compiler-rt
- [x] compiletest
- [x] doc
- [x] driver
- [x] etc
- [x] grammar
- [x] jemalloc
- [x] liballoc
- [x] libarena
- [x] libbacktrace
- [x] libcollections
- [x] libcore
- [x] libcoretest
- [x] libdebug
- [x] libflate
- [x] libfmt_macros
- [x] libfourcc
- [x] libgetopts
- [x] libglob
- [x] libgraphviz
- [x] libgreen
- [x] libhexfloat
- [x] liblibc
- [x] liblog
- [x] libnative
- [x] libnum
- [x] librand
- [x] librbml
- [x] libregex
- [x] libregex_macros
- [x] librlibc
- [x] librustc
- [x] librustc_back
- [x] librustc_llvm
- [x] librustdoc
- [x] librustrt
- [x] libsemver
- [x] libserialize
- [x] libstd
- [x] libsync
- [x] libsyntax
- [x] libterm
- [x] libtest
- [x] libtime
- [x] libunicode
- [x] liburl
- [x] libuuid
- [x] llvm
- [x] rt
- [x] test
@ghost
Copy link

ghost commented Oct 30, 2014

This is now done. Amazing work, @steveklabnik!

@ghost ghost closed this as completed Oct 30, 2014
@steveklabnik
Copy link
Member

🎊 ❤️

zofrex pushed a commit to zofrex/cryptopals that referenced this issue Feb 15, 2015
zofrex pushed a commit to zofrex/cryptopals that referenced this issue Feb 15, 2015
zofrex added a commit to zofrex/cryptopals that referenced this issue Feb 15, 2015
cadencemarseille added a commit to cadencemarseille/rust-pcre that referenced this issue May 16, 2015
lnicola pushed a commit to lnicola/rust that referenced this issue Jul 11, 2024
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B-RFC-approved Blocker: Approved by a merged RFC but not yet implemented.
Projects
None yet
Development

No branches or pull requests

6 participants