Give compile_error macro examples #46512
Merged
Conversation
This file contains 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
|
r? @kennytm (rust_highfive has picked a reviewer for you, use r? to override) |
kennytm
reviewed
Dec 5, 2017
src/libstd/macros.rs
Outdated
| /// compile_error!("This macro only accepts `foo` or `bar`"); | ||
| /// } | ||
| /// } | ||
| /// ``` |
There was a problem hiding this comment.
This example is currently giving an unused_macros warning. Please do use the macro e.g.
give_me_foo_or_bar!(neither);
// ^ will fail at compile time with message "This macro only accepts `foo` or `bar`"
kennytm
added
the
S-waiting-on-review
|
LGTM minus Travis. cc @rust-lang/docs |
|
Literally took your two lines there and patched them into the example. |
src/libstd/macros.rs
Outdated
| /// | ||
| /// [RFC]: https://github.com/rust-lang/rfcs/blob/master/text/1695-add-error-macro.md | ||
| /// # Examples | ||
| /// Two such examples are macros and `#[cfg]` environments. |
There was a problem hiding this comment.
Please add an empty line before this one.
| /// give_me_foo_or_bar!(neither); | ||
| /// // ^ will fail at compile time with message "This macro only accepts `foo` or `bar`" | ||
| /// ``` | ||
| /// |
There was a problem hiding this comment.
Please add a sentence in here (no need for a big one!) so we don't just have two code blocks following each other.
|
@bors r+ rollup |
|
📌 Commit aaaea2c has been approved by |
kennytm
added
S-waiting-on-bors
frewsxcv
added a commit
to frewsxcv/rust
that referenced
this pull request
Dec 6, 2017
Give compile_error macro examples I cannot get Rust to build at all with it complaining about GCC not being a valid C compiler or something, so letting TravisCI be my tester... Fixes rust-lang#46171
bors
added a commit
that referenced
this pull request
Dec 6, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I cannot get Rust to build at all with it complaining about GCC not being a valid C compiler or something, so letting TravisCI be my tester...
Fixes #46171