Add documentation about env! second argument #51014
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
rust-highfive
added
the
S-waiting-on-review
QuietMisdreavus
suggested changes
May 23, 2018
src/libstd/macros.rs
Outdated
| @@ -390,6 +389,20 @@ pub mod builtin { | |||
| /// let path: &'static str = env!("PATH"); | |||
| /// println!("the $PATH variable at the time of compiling was: {}", path); | |||
| /// ``` | |||
| /// | |||
| /// Please note that you can customize the compilation error by passing | |||
There was a problem hiding this comment.
"You can customize the error message by passing a string as the second parameter:"
src/libstd/macros.rs
Outdated
| /// ``` | ||
| /// | ||
| /// And you'll get a wonderful error (unless the `documentation` | ||
| /// environment variable is defined on your computer for some reason...): |
There was a problem hiding this comment.
"If the documentation environment variable is not defined, you'll get the following error:"
src/libstd/macros.rs
Outdated
| /// environment variable is defined on your computer for some reason...): | ||
| /// | ||
| /// ```text | ||
| /// error: what's that?! |
There was a problem hiding this comment.
I think "error" should be all-caps here; isn't that how the compiler outputs it?
There was a problem hiding this comment.
I copied/pasted the compiler output so apparently no...
There was a problem hiding this comment.
Oh, well in that case we can leave it, lol.
|
Updated. |
QuietMisdreavus
approved these changes
May 24, 2018
|
Thanks so much! r=me pending travis. |
|
@bors r+ rollup |
|
📌 Commit fe9a195 has been approved by |
bors
added
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
May 26, 2018
…dreavus Add documentation about env! second argument Fixes rust-lang#48044. r? @QuietMisdreavus
bors
added a commit
that referenced
this pull request
May 26, 2018
Rollup of 11 pull requests Successful merges: - #50987 (Underline multiple suggested replacements in the same line) - #51014 (Add documentation about env! second argument) - #51034 (Remove unused lowering field and method) - #51047 (Use AllFacts from polonius-engine) - #51048 (Add more missing examples for Formatter) - #51056 (Mention and use `Once::new` instead of `ONCE_INIT`) - #51059 (What does an expression look like, that consists only of special characters?) - #51065 (Update nomicon link in transmute docs) - #51067 (Add inner links in documentation) - #51070 (Fail typecheck if we encounter a bogus break) - #51073 (Rename TokenStream::empty to TokenStream::new) Failed merges:
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.
Fixes #48044.
r? @QuietMisdreavus