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.

Sign up for GitHub

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

Jump to bottom

Document Item type in std::env::SplitPaths iterator. #60022

Merged
merged 1 commit into from
Apr 28, 2019
Merged

Document Item type in std::env::SplitPaths iterator. #60022

merged 1 commit into from
Apr 28, 2019

Conversation

nathankleyn
Copy link
Contributor

Previously there wasn't any documentation to show what the type of
Item was inside std::env::SplitPaths. Now, in the same format as
other examples of docs in std for Iterator#Item, we mention the
type.

This fixes #59543.

r? @steveklabnik

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 16, 2019
@rust-highfive
Copy link
Collaborator

The job x86_64-gnu-llvm-6.0 of your PR failed on Travis (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log. 
travis_time:end:001e8e6b:start=1555450959691265069,finish=1555450960451316377,duration=760051308
$ git checkout -qf FETCH_HEAD
travis_fold:end:git.checkout

Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions
$ export SCCACHE_BUCKET=rust-lang-ci-sccache2
$ export SCCACHE_REGION=us-west-1
$ export GCP_CACHE_BUCKET=rust-lang-ci-cache
$ export AWS_ACCESS_KEY_ID=AKIA46X5W6CZEJZ6XT55
---
[00:59:44] 380 |   /// ```
[00:59:44]     |  _____^
[00:59:44] 381 | | /// use std::env;
[00:59:44] 382 | | ///
[00:59:44] 383 | | /// let key = "PATH";
[00:59:44] ...   |
[00:59:44] 393 | | /// [`PathBuf`]: ../../std/path/struct.PathBuf.html
[00:59:44]     | |_______^
[00:59:44]     |
[00:59:44]     = note: error from rustc: unknown start of token: `
[00:59:44] help: mark blocks that do not contain Rust code as text
[00:59:44] help: mark blocks that do not contain Rust code as text
[00:59:44]     |
[00:59:44] 380 | /// ```text
[00:59:44]     |     ^^^^^^^
[00:59:44] 
[00:59:58] error: Could not document `std`.
[00:59:58] 
[00:59:58] Caused by:
[00:59:58]   process didn't exit successfully: `/checkout/obj/build/bootstrap/debug/rustdoc --edition=2018 --crate-name std src/libstd/lib.rs --color always --target x86_64-unknown-linux-gnu -o /checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/doc --cfg 'feature="backtrace"' --cfg 'feature="backtrace-sys"' --cfg 'feature="compiler_builtins"' --cfg 'feature="compiler_builtins_c"' --cfg 'feature="default"' --cfg 'feature="panic-unwind"' --cfg 'feature="panic_unwind"' --cfg 'feature="std_detect_dlsym_getauxval"' --cfg 'feature="std_detect_file_io"' --markdown-css rust.css --markdown-no-toc --generate-redirect-pages --resource-suffix 1.35.0 --index-page /checkout/src/doc/index.md -L dependency=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps -L dependency=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/release/deps --extern alloc=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/liballoc-85a5b03f4dbeb3fc.rmeta --extern backtrace_sys=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libbacktrace_sys-b514524da6d4e020.rmeta --extern compiler_builtins=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libcompiler_builtins-a2596cc866c4c433.rmeta --extern core=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libcore-c94a89edb07c8a5f.rmeta --extern libc=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/liblibc-06d5c99c45a52546.rmeta --extern panic_abort=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libpanic_abort-67c85586690029a4.rmeta --extern panic_unwind=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libpanic_unwind-c3afe6bef2cd541a.rmeta --extern rustc_demangle=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/librustc_demangle-d8fcf90ffb67d41d.rmeta --extern rustc_asan=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/librustc_asan-8aec463b0506158d.rmeta --extern rustc_lsan=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/librustc_lsan-d61e284d5f90deac.rmeta --extern rustc_msan=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/librustc_msan-6ae4b042a3e6fd87.rmeta --extern rustc_tsan=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/librustc_tsan-1dd044cc73237cf1.rmeta --extern unwind=/checkout/obj/build/x86_64-unknown-linux-gnu/stage1-std/x86_64-unknown-linux-gnu/release/deps/libunwind-29c6107d54420313.rmeta` (exit code: 1)
[00:59:58] 
[00:59:58] 
[00:59:58] command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/cargo" "rustdoc" "--target" "x86_64-unknown-linux-gnu" "-j" "4" "--release" "--locked" "--color" "always" "--features" "panic-unwind backtrace" "--manifest-path" "/checkout/src/libstd/Cargo.toml" "-Z" "unstable-options" "-p" "std" "--" "--markdown-css" "rust.css" "--markdown-no-toc" "--generate-redirect-pages" "--resource-suffix" "1.35.0" "--index-page" "/checkout/src/doc/index.md"
[00:59:58] 
[00:59:58] 
[00:59:58] failed to run: /checkout/obj/build/bootstrap/debug/bootstrap doc
[00:59:58] Build completed unsuccessfully in 0:08:11

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@nathankleyn
Document Item type in std::env::SplitPaths iterator.
8951eea 
Previously there wasn't any documentation to show what the type of
`Item` was inside `std::env::SplitPaths`. Now, in the same format as
other examples of docs in `srd` for `Iterator#Item`, we mention the
type.

This fixes rust-lang#59543.
@brettcannon brettcannon mentioned this pull request Apr 27, 2019
Closed
@Centril
Copy link
Contributor

Centril commented Apr 28, 2019

r? @Centril @bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 28, 2019

📌 Commit 8951eea has been approved by Centril

@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 Apr 28, 2019
Centril added a commit to Centril/rust that referenced this pull request Apr 28, 2019
@Centril
Rollup merge of rust-lang#60022 - nathankleyn:fix-issue-59543, r=Centril
95abeb0 
Document `Item` type in `std::env::SplitPaths` iterator.

Previously there wasn't any documentation to show what the type of
`Item` was inside `std::env::SplitPaths`. Now, in the same format as
other examples of docs in `std` for `Iterator#Item`, we mention the
type.

This fixes rust-lang#59543.

r? @steveklabnik
@Centril Centril mentioned this pull request Apr 28, 2019
Merged
bors added a commit that referenced this pull request Apr 28, 2019
@bors
Auto merge of #60351 - Centril:rollup-5xv3tka, r=Centril
012c300 
Rollup of 4 pull requests

Successful merges:

 - #60022 (Document `Item` type in `std::env::SplitPaths` iterator.)
 - #60270 (rustc: Flag metadata compatible with multiple CGUs)
 - #60325 (Document ast::ExprKind::Type)
 - #60347 (Remove `-Z two-phase-borrows` and `-Z two-phase-beyond-autoref`)

Failed merges:

r? @ghost
@bors
Copy link
Contributor

bors commented Apr 28, 2019

⌛ Testing commit 8951eea with merge 012c300...

@bors bors merged commit 8951eea into rust-lang:master Apr 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tesuji tesuji tesuji left review comments

@brettcannon brettcannon brettcannon approved these changes

Assignees

@Centril Centril

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

std::env::SplitPaths does not document its Item type
7 participants
@nathankleyn @rust-highfive @Centril @bors @brettcannon @tesuji @steveklabnik