Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix formatting in the docs for std::process::Command::envs() #40794

Merged
merged 2 commits into from
Mar 25, 2017

Conversation

s3rvac
Copy link
Contributor

@s3rvac s3rvac commented Mar 24, 2017

An empty line between the Basic usage: text and the example is required to properly format the code. Without the empty line, the example is not formatted as code.

Here you can see the current (improper) formatting.

An empty line between the "Basic usage:" text and the example is required to
properly format the code. Without the empty line, the example is not formatted
as code.
@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@alexcrichton
Copy link
Member

The travis failure looks like it may not be spurious?

…and::envs().

The person who originally wrote the example forgot to include this attribute.
This caused Travis CI to fail on commit 9b0a4a4 (rust-lang#40794), which just fixed
formatting in the description of std::process::Command::envs().
@steveklabnik
Copy link
Member

@alexcrichton .... uh oh.

Good thing standard style is to put these lines in, and now that we've switched to CommonMark, the old way won't be rendered properly, so this should shake out? But yeah that's not good.

@steveklabnik
Copy link
Member

r=me if travis passes

thanks @s3rvac !

@alexcrichton
Copy link
Member

@bors: r=steveklabnik

@bors
Copy link
Contributor

bors commented Mar 24, 2017

📌 Commit 432673a has been approved by steveklabnik

@s3rvac
Copy link
Contributor Author

s3rvac commented Mar 24, 2017

@alexcrichton Looks like that the person who originally wrote the example forgot to include the feature attribute. Now that the example is being properly parsed, this resulted in a failure. I have added the missing attribute to the example in commit 432673a. Hopefully, this will fix the tests.

@s3rvac
Copy link
Contributor Author

s3rvac commented Mar 24, 2017

This time it looks like a spurious fail that has nothing to do with the PR:

The command "eval git fetch origin +refs/pull/40794/merge: " failed 3 times.

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Mar 24, 2017
…vs-docs, r=steveklabnik

Fix formatting in the docs for std::process::Command::envs()

An empty line between the *Basic usage:* text and the example is required to properly format the code. Without the empty line, the example is not formatted as code.

[Here](https://doc.rust-lang.org/std/process/struct.Command.html#method.envs) you can see the current (improper) formatting.
bors added a commit that referenced this pull request Mar 24, 2017
Rollup of 8 pull requests

- Successful merges: #40567, #40602, #40636, #40739, #40756, #40790, #40794, #40803
- Failed merges:
@bors bors merged commit 432673a into rust-lang:master Mar 25, 2017
@s3rvac s3rvac deleted the fix-formatting-in-command-envs-docs branch March 25, 2017 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants