Skip to content

Add documentation about env! second argument - #51014

Merged
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:env_docs
May 26, 2018
Merged

Add documentation about env! second argument#51014
bors merged 1 commit into
rust-lang:masterfrom
GuillaumeGomez:env_docs

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 23, 2018

@QuietMisdreavus QuietMisdreavus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a little too informal for my tastes. Here are some suggestions.

I'm a little cautious about the specific error message you used, too, but i think i'll let that fly.

Comment thread src/libstd/macros.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"You can customize the error message by passing a string as the second parameter:"

Comment thread src/libstd/macros.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"If the documentation environment variable is not defined, you'll get the following error:"

Comment thread src/libstd/macros.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "error" should be all-caps here; isn't that how the compiler outputs it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied/pasted the compiler output so apparently no...

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, well in that case we can leave it, lol.

@GuillaumeGomez

Copy link
Copy Markdown
Member Author

Updated.

@QuietMisdreavus

Copy link
Copy Markdown
Contributor

Thanks so much! r=me pending travis.

@QuietMisdreavus

Copy link
Copy Markdown
Contributor

@bors r+ rollup

@bors

bors commented May 24, 2018

Copy link
Copy Markdown
Collaborator

📌 Commit fe9a195 has been approved by QuietMisdreavus

@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 May 24, 2018
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:
@bors
bors merged commit fe9a195 into rust-lang:master May 26, 2018
@GuillaumeGomez
GuillaumeGomez deleted the env_docs branch May 26, 2018 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants