Skip to content

Fix incorrect use of compile_fail - #121046

Merged
bors merged 1 commit into
rust-lang:masterfrom
camelid:rm-incorrect-compile_fail
Feb 14, 2024
Merged

Fix incorrect use of compile_fail#121046
bors merged 1 commit into
rust-lang:masterfrom
camelid:rm-incorrect-compile_fail

Conversation

@camelid

@camelid camelid commented Feb 13, 2024

Copy link
Copy Markdown
Member

compile_fail should only be used when the code is meant to show what not to do. In other words, there should be a fundamental flaw in the code. However, in this case, the example is just incomplete, so we should use ignore to avoid confusing readers.

@camelid
Fix incorrect use of compile_fail
cd3ba4a 
`compile_fail` should only be used when the code is meant to show
what *not* to do. In other words, there should be a fundamental flaw
in the code. However, in this case, the example is just incomplete,
so we should use `ignore` to avoid confusing readers.
@rustbot

rustbot commented Feb 13, 2024

Copy link
Copy Markdown
Collaborator

r? @Mark-Simulacrum

rustbot has assigned @Mark-Simulacrum.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Feb 13, 2024
@camelid camelid added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Feb 13, 2024
@Noratrieb

Noratrieb commented Feb 13, 2024

Copy link
Copy Markdown
Member

ideally we'd use # to get the example working. this seems a bit annoying to do portably here though, so just ignoring it seems fine
@bors r+ rollup

@bors

bors commented Feb 13, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit cd3ba4a has been approved by Nilstrieb

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 13, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 13, 2024
@matthiaskrgr
Rollup merge of rust-lang#121046 - camelid:rm-incorrect-compile_fail,…
6df19a2 
… r=Nilstrieb

Fix incorrect use of `compile_fail`

`compile_fail` should only be used when the code is meant to show what *not* to do. In other words, there should be a fundamental flaw in the code. However, in this case, the example is just incomplete, so we should use `ignore` to avoid confusing readers.
@matthiaskrgr matthiaskrgr mentioned this pull request Feb 13, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 13, 2024
@bors
Auto merge of rust-lang#121054 - matthiaskrgr:rollup-k3fuez5, r=matth…
e9a16fd 
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#118882 (Check normalized call signature for WF in mir typeck)
 -