Fix incorrect use of compile_fail
#121046
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`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 has assigned @Mark-Simulacrum. Use r? to explicitly pick a reviewer |
rustbot
added
S-waiting-on-review
camelid
added
the
A-docs
|
ideally we'd use |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Feb 13, 2024
… 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.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 13, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#118882 (Check normalized call signature for WF in mir typeck) - rust-lang#120999 (rustdoc: replace `clean::InstantiationParam` with `clean::GenericArg`) - rust-lang#121002 (remove unnecessary calls to `commit_if_ok`) - rust-lang#121005 (Remove jsha from the rustdoc review rotation) - rust-lang#121043 (add lcnr to the compiler-team assignment group) - rust-lang#121045 (Fix two UI tests with incorrect directive / invalid revision) - rust-lang#121046 (Fix incorrect use of `compile_fail`) - rust-lang#121047 (Do not assemble candidates for default impls) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 13, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#118882 (Check normalized call signature for WF in mir typeck) - rust-lang#120999 (rustdoc: replace `clean::InstantiationParam` with `clean::GenericArg`) - rust-lang#121002 (remove unnecessary calls to `commit_if_ok`) - rust-lang#121005 (Remove jsha from the rustdoc review rotation) - rust-lang#121014 (Remove `force_print_diagnostic`) - rust-lang#121043 (add lcnr to the compiler-team assignment group) - rust-lang#121046 (Fix incorrect use of `compile_fail`) - rust-lang#121047 (Do not assemble candidates for default impls) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 14, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#118882 (Check normalized call signature for WF in mir typeck) - rust-lang#120999 (rustdoc: replace `clean::InstantiationParam` with `clean::GenericArg`) - rust-lang#121002 (remove unnecessary calls to `commit_if_ok`) - rust-lang#121005 (Remove jsha from the rustdoc review rotation) - rust-lang#121014 (Remove `force_print_diagnostic`) - rust-lang#121043 (add lcnr to the compiler-team assignment group) - rust-lang#121046 (Fix incorrect use of `compile_fail`) - rust-lang#121047 (Do not assemble candidates for default impls) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 14, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#118882 (Check normalized call signature for WF in mir typeck) - rust-lang#120999 (rustdoc: replace `clean::InstantiationParam` with `clean::GenericArg`) - rust-lang#121002 (remove unnecessary calls to `commit_if_ok`) - rust-lang#121005 (Remove jsha from the rustdoc review rotation) - rust-lang#121014 (Remove `force_print_diagnostic`) - rust-lang#121043 (add lcnr to the compiler-team assignment group) - rust-lang#121046 (Fix incorrect use of `compile_fail`) - rust-lang#121047 (Do not assemble candidates for default impls) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 14, 2024
Rollup merge of rust-lang#121046 - camelid:rm-incorrect-compile_fail, 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
compile_failshould 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 useignoreto avoid confusing readers.