Improving std::env docs #42091

maccoda · 2017-05-18T23:11:07Z

Addresses #29351.
Hopefully this addresses the following points:

iterators should use the standard iterator boilerplate like https://doc.rust-lang.org/std/iter/struct.Map.html, this applies to all structs except for JoinPathsError

JoinPathsError should properly link the function it comes from and use language similar to https://doc.rust-lang.org/std/io/struct.Error.html

same wording issues with VarError

functions need to ensure linkage to things they refer to in their descriptions

Explain the difference between os and non-os structs and methods

rust-highfive · 2017-05-18T23:11:19Z

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.

maccoda · 2017-05-18T23:12:39Z

r? @steveklabnik

maccoda · 2017-05-18T23:13:33Z

src/libstd/env.rs

@@ -13,6 +13,13 @@
 //! This module contains functions to inspect various aspects such as
 //! environment variables, process arguments, the current directory, and various
 //! other important directories.
+//!
+//! There are several functions and structs in this module that have a


I am not convinced this is the best way to describe this. Does this read alright for you?

frewsxcv · 2017-05-19T19:02:51Z

[00:43:03] Linkcheck (x86_64-unknown-linux-gnu)
[00:43:04] std/env/fn.join_paths.html:56: broken link - std/env/containing%20an%20error%20message
[00:43:08] thread 'main' panicked at 'found some broken links', /checkout/src/tools/linkchecker/main.rs:49

frewsxcv · 2017-05-19T19:03:59Z

src/libstd/env.rs

 ///
-/// Returns an [`Err`][err] (containing an error message) if one of the input
+/// Returns an [`Err`] (containing an error message) if one of the input


Markdown treats this as a link because it's following parens

You'll need to do something like:

Returns an [`Err`][`Err`] (containing...

or just

Returns an [`Err`][] (containing...

Ah of course! Thank you.

bors · 2017-05-19T23:40:38Z

☔ The latest upstream changes (presumably #42105) made this pull request unmergeable. Please resolve the merge conflicts.

maccoda · 2017-05-20T01:33:57Z

@steveklabnik All seems to be good now. Were there any changes you were wanting?

Mark-Simulacrum · 2017-05-20T01:38:31Z

Could you squash your commits? Otherwise looks good to me, but @steveklabnik or someone else from doc team should review.

maccoda · 2017-05-20T03:05:39Z

@Mark-Simulacrum What would be the best way to do this since I needed to do a merge to align to master. Just gave it a shot and have really messed up the history as it rebased the 100 or so commits in between mine on top of mine 😞

frewsxcv · 2017-05-20T03:22:01Z

Looks good to me, thanks for your contribution!

@bors r+ rollup

bors · 2017-05-20T03:22:02Z

📌 Commit 55d75c4 has been approved by frewsxcv

Mark-Simulacrum · 2017-05-20T03:23:48Z

Ah, no worries about the squashing -- I think http://stackoverflow.com/questions/15727597/git-how-to-rebase-and-squash-commits-from-branch-to-master might help if you're interested, but it's not really all that big a problem.

Mark-Simulacrum · 2017-05-20T03:23:58Z

err... I did not want to close this.

maccoda · 2017-05-20T04:50:46Z

@frewsxcv Not sure if bors need to be reminded again with the accidental close 😄

frewsxcv · 2017-05-20T04:54:03Z

should be fine, the PR is still in the queue

https://buildbot2.rust-lang.org/homu/queue/rust

maccoda · 2017-05-20T04:56:24Z

Ah I did not know that existed. Great thanks!

bors · 2017-05-20T05:20:15Z

⌛ Testing commit 55d75c4 with merge 6ee90e3...

bors · 2017-05-20T05:52:10Z

💔 Test failed - status-travis

maccoda · 2017-05-20T05:58:39Z

[00:01:11] # configuration written to .config
[00:01:11] #
[00:01:11] + hide_output ct-ng build
[00:01:11] + set +x
[00:01:41] Sat May 20 05:27:24 UTC 2017 - building ...
[00:02:11] Sat May 20 05:27:54 UTC 2017 - building ...
[00:02:41] Sat May 20 05:28:24 UTC 2017 - building ...
[00:03:11] Sat May 20 05:28:54 UTC 2017 - building ...
[00:03:41] Sat May 20 05:29:24 UTC 2017 - building ...
[00:04:11] Sat May 20 05:29:54 UTC 2017 - building ...
[00:04:41] Sat May 20 05:30:24 UTC 2017 - building ...
[00:05:11] Sat May 20 05:30:54 UTC 2017 - building ...
[00:05:41] Sat May 20 05:31:24 UTC 2017 - building ...
[00:05:57] ERROR: An error was encountered with the build.
[INFO ]  Performing some trivial sanity checks
[INFO ]  Build started 20170520.052654
[INFO ]  Building environment variables
[INFO ]  =================================================================
[INFO ]  Retrieving needed toolchain components' tarballs
[ERROR]  
[ERROR]  >>
[ERROR]  >>  Build failed in step 'Retrieving needed toolchain components' tarballs'
[ERROR]  >>        called in step '(top-level)'
[ERROR]  >>
[ERROR]  >>  Error happened in: do_isl_get[scripts/build/companion_libs/121-isl.sh@741]
[ERROR]  >>        called from: do_companion_libs_get[scripts/build/companion_libs.sh@15]
[ERROR]  >>        called from: main[scripts/crosstool-NG.sh@591]
[ERROR]  >>
[ERROR]  >>  For more info on this error, look at the file: 'build.log'
[ERROR]  >>  There is a list of known issues, some with workarounds, in:
[ERROR]  >>      '/usr/local/share/doc/crosstool-ng/crosstool-ng-1.22.0/B - Known issues.txt'
[ERROR]  
[ERROR]  (elapsed: 4:46.72)

Any ideas on that one?

Mark-Simulacrum · 2017-05-20T12:27:34Z

@bors retry

Tracking issue for spurious network failures on bots #40474: Spurious failure downloading crosstool-ng I assume.

Improving std::env docs Addresses rust-lang#29351. Hopefully this addresses the following points: > - iterators should use the standard iterator boilerplate like https://doc.rust-lang.org/std/iter/struct.Map.html, this applies to all structs except for JoinPathsError > - JoinPathsError should properly link the function it comes from and use language similar to https://doc.rust-lang.org/std/io/struct.Error.html > - same wording issues with VarError > - functions need to ensure linkage to things they refer to in their descriptions > - Explain the difference between `os` and non-`os` structs and methods

Rollup of 6 pull requests - Successful merges: #41892, #42062, #42091, #42093, #42098, #42127 - Failed merges:

std::env docs

fb19560

rust-highfive assigned brson May 18, 2017

rust-highfive assigned steveklabnik and unassigned brson May 18, 2017

maccoda commented May 18, 2017

View reviewed changes

frewsxcv reviewed May 19, 2017

View reviewed changes

shepmaster added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label May 19, 2017

Fixed link issue.

b69b641

Merge branch 'master' into maccoda/env_docs

55d75c4

Mark-Simulacrum closed this May 20, 2017

Mark-Simulacrum reopened this May 20, 2017

Mark-Simulacrum 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 20, 2017

Mark-Simulacrum mentioned this pull request May 20, 2017

Rollup of 6 pull requests #42130

Merged

bors added a commit that referenced this pull request May 21, 2017

Auto merge of #42130 - Mark-Simulacrum:rollup, r=Mark-Simulacrum

7ac844f

Rollup of 6 pull requests - Successful merges: #41892, #42062, #42091, #42093, #42098, #42127 - Failed merges:

bors merged commit 55d75c4 into rust-lang:master May 21, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving std::env docs #42091

Improving std::env docs #42091

maccoda commented May 18, 2017

rust-highfive commented May 18, 2017

maccoda commented May 18, 2017

maccoda May 18, 2017 •

edited

Loading

frewsxcv commented May 19, 2017

frewsxcv May 19, 2017

maccoda May 19, 2017

bors commented May 19, 2017

maccoda commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

maccoda commented May 20, 2017

frewsxcv commented May 20, 2017

bors commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

maccoda commented May 20, 2017

frewsxcv commented May 20, 2017

maccoda commented May 20, 2017

bors commented May 20, 2017

bors commented May 20, 2017

maccoda commented May 20, 2017 •

edited

Loading

Mark-Simulacrum commented May 20, 2017

Improving std::env docs #42091

Improving std::env docs #42091

Conversation

maccoda commented May 18, 2017

rust-highfive commented May 18, 2017

maccoda commented May 18, 2017

maccoda May 18, 2017 • edited Loading

Choose a reason for hiding this comment

frewsxcv commented May 19, 2017

frewsxcv May 19, 2017

Choose a reason for hiding this comment

maccoda May 19, 2017

Choose a reason for hiding this comment

bors commented May 19, 2017

maccoda commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

maccoda commented May 20, 2017

frewsxcv commented May 20, 2017

bors commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

Mark-Simulacrum commented May 20, 2017

maccoda commented May 20, 2017

frewsxcv commented May 20, 2017

maccoda commented May 20, 2017

bors commented May 20, 2017

bors commented May 20, 2017

maccoda commented May 20, 2017 • edited Loading

Mark-Simulacrum commented May 20, 2017

maccoda May 18, 2017 •

edited

Loading

maccoda commented May 20, 2017 •

edited

Loading