Skip to content

Update API docs and conventions for fail -> panic #18677

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.

Sign up for GitHub

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

Jump to bottom
Closed
brson opened this issue Nov 6, 2014 · 4 comments · Fixed by #18773
Closed

Update API docs and conventions for fail -> panic #18677

brson opened this issue Nov 6, 2014 · 4 comments · Fixed by #18773
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@brson
Copy link
Contributor

brson commented Nov 6, 2014

Many of the in-tree API docs still have #Failure sections. The new convention appears to be #Panics.
@brson brson added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Nov 6, 2014
@brson brson mentioned this issue Nov 6, 2014
Merged
@subhashb
Copy link

subhashb commented Nov 6, 2014

@steveklabnik I see you handled most of it in #17894 😄
Shall I take a stab at this cleanup?

@steveklabnik
Copy link
Member

@subhashb sure, if you'd like to, feel free :)

@Gankra
Copy link
Contributor

Gankra commented Nov 6, 2014

@subhashb Note that I fixed a few in collections in my reform branch. Hopefully will land today.

@subhashb
Copy link

subhashb commented Nov 6, 2014

@gankro Noted. Will skip around those files while your PR gets merged.

@subhashb subhashb mentioned this issue Nov 8, 2014
Merged
@sheroze1123 sheroze1123 mentioned this issue Nov 15, 2014
Closed
bors added a commit that referenced this issue Nov 20, 2014
@bors
auto merge of #18773 : subhashb/rust/convert_remaining_failures_to_pa…
770378a 
…nic, r=steveklabnik

I have also renamed `fail` to `panic` in some non-documentation comments, where I thought it mattered.
Fixes #18677 

cc @steveklabnik
lnicola pushed a commit to lnicola/rust that referenced this issue Dec 16, 2024
@Veykril
Merge pull request rust-lang#18677 from Veykril/push-uumpxklsqpzk
c57aec8 
internal: Implement `naked_asm!` builtin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rename remaining Failures in Documentation to Panic
4 participants
@steveklabnik @brson @subhashb @Gankra