Skip to content

Increase visibility of join_path and split_paths #119748

New issue

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

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

Already on GitHub? # to your account

Closed
wants to merge 1 commit into from

Conversation

tgross35
Copy link
Contributor

@tgross35 tgross35 commented Jan 8, 2024

Add some crosslinking among std::env pages to make it easier to discover join_paths and split_paths. Also add aliases to help anyone searching for PATH.

@rustbot
Copy link
Collaborator

rustbot commented Jan 8, 2024

r? @joshtriplett

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jan 8, 2024
@tgross35 tgross35 force-pushed the suggest-path-split branch 2 times, most recently from 48eabf8 to 3e64f68 Compare January 8, 2024 19:01
@tgross35
Copy link
Contributor Author

tgross35 commented Jan 8, 2024

@rustbot label +A-docs

@rustbot
Copy link
Collaborator

rustbot commented Jan 8, 2024

Error: Parsing relabel command in comment failed: ...' label +' | error: empty label at >| ' A-docs '...

Please file an issue on GitHub at triagebot if there's a problem with this bot, or reach out on #t-infra on Zulip.

@rustbot rustbot added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jan 8, 2024
@tgross35 tgross35 force-pushed the suggest-path-split branch from 3e64f68 to aca631f Compare January 8, 2024 20:40
@ChrisDenton
Copy link
Member

I have mixed feelings about the doc alias. If I'm a new user doing a search for "path" then I'm probably looking for std::path::Path. But the doc alises push that down to the fourth result. Also doc alises ignore case, so it's rendered as:

path - see std::env::split_paths
path - see std::env::join_paths

rendered

@joshtriplett
Copy link
Member

r? libs-api

@rustbot rustbot added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Feb 11, 2024
@rustbot rustbot assigned Amanieu and unassigned joshtriplett Feb 11, 2024
@Amanieu
Copy link
Member

Amanieu commented Feb 21, 2024

@tgross35 This is fine, but the doc aliases should be removed. Searching for "path" should point users to the Path type, not this (rustdoc search is case insensitive).

@Amanieu Amanieu added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 21, 2024
Add some crosslinking among `std::env` pages. Also add aliases to help anyone
searching for `PATH`.
@tgross35
Copy link
Contributor Author

tgross35 commented Feb 28, 2024

Slipped my mind, removed the aliases so this should be ready.

(squashed the typo fix commit)

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 28, 2024
@Amanieu
Copy link
Member

Amanieu commented Feb 29, 2024

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Feb 29, 2024

📌 Commit 0de3677 has been approved by Amanieu

It is now in the queue for this repository.

@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 Feb 29, 2024
jhpratt added a commit to jhpratt/rust that referenced this pull request Feb 29, 2024
…nieu

Increase visibility of `join_path` and `split_paths`

Add some crosslinking among `std::env` pages to make it easier to discover `join_paths` and `split_paths`. Also add aliases to help anyone searching for `PATH`.
jhpratt added a commit to jhpratt/rust that referenced this pull request Feb 29, 2024
…nieu

Increase visibility of `join_path` and `split_paths`

Add some crosslinking among `std::env` pages to make it easier to discover `join_paths` and `split_paths`. Also add aliases to help anyone searching for `PATH`.
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
Rollup of 11 pull requests

Successful merges:

 - rust-lang#119748 (Increase visibility of `join_path` and `split_paths`)
 - rust-lang#120291 (Have `String` use `SliceIndex` impls from `str`)
 - rust-lang#121130 (Suggest moving definition if non-found macro_rules! is defined later)
 - rust-lang#121723 (Two diagnostic things)
 - rust-lang#121740 (Changing some attributes to only_local.)
 - rust-lang#121745 (Deeply normalize obligations in `refining_impl_trait`)
 - rust-lang#121748 (Restore the standard library review rotation to its former glory)
 - rust-lang#121768 (Implement unwind safety for Condvar on all platforms )
 - rust-lang#121777 (Fix typo in `rustc_passes/messages.ftl`)
 - rust-lang#121778 (Document potential memory leak in unbounded channel)
 - rust-lang#121779 (Remove unused diagnostic struct)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
Rollup of 10 pull requests

Successful merges:

 - rust-lang#119748 (Increase visibility of `join_path` and `split_paths`)
 - rust-lang#120291 (Have `String` use `SliceIndex` impls from `str`)
 - rust-lang#121723 (Two diagnostic things)
 - rust-lang#121740 (Changing some attributes to only_local.)
 - rust-lang#121745 (Deeply normalize obligations in `refining_impl_trait`)
 - rust-lang#121748 (Restore the standard library review rotation to its former glory)
 - rust-lang#121768 (Implement unwind safety for Condvar on all platforms )
 - rust-lang#121777 (Fix typo in `rustc_passes/messages.ftl`)
 - rust-lang#121778 (Document potential memory leak in unbounded channel)
 - rust-lang#121779 (Remove unused diagnostic struct)

r? `@ghost`
`@rustbot` modify labels: rollup
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
Rollup merge of rust-lang#119748 - tgross35:suggest-path-split, r=Amanieu

Increase visibility of `join_path` and `split_paths`

Add some crosslinking among `std::env` pages to make it easier to discover `join_paths` and `split_paths`. Also add aliases to help anyone searching for `PATH`.
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
…llaumeGomez

Rollup of 10 pull requests

Successful merges:

 - rust-lang#118217 (Document which methods on `f64` are precise)
 - rust-lang#119748 (Increase visibility of `join_path` and `split_paths`)
 - rust-lang#121412 (platform docs: clarify hexagon-unknown-none-elf example, add hexagon-unknown-linux-musl)
 - rust-lang#121654 (Fix `async Fn` confirmation for `FnDef`/`FnPtr`/`Closure` types)
 - rust-lang#121700 (CFI: Don't compress user-defined builtin types)
 - rust-lang#121765 (add platform-specific function to get the error number for HermitOS)
 - rust-lang#121781 (bootstrap/format: send larger batches to rustfmt)
 - rust-lang#121788 (bootstrap: fix clap deprecated warnings)
 - rust-lang#121792 (Improve renaming suggestion when item starts with underscore)
 - rust-lang#121793 (Document which methods on `f32` are precise)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
…llaumeGomez

Rollup of 7 pull requests

Successful merges:

 - rust-lang#119748 (Increase visibility of `join_path` and `split_paths`)
 - rust-lang#120820 (Enable CMPXCHG16B, SSE3, SAHF/LAHF and 128-bit Atomics (in nightly) in Windows x64)
 - rust-lang#121000 (pattern_analysis: rework how we hide empty private fields)
 - rust-lang#121376 (Skip unnecessary comparison with half-open range patterns)
 - rust-lang#121596 (Use volatile access instead of `#[used]` for `on_tls_callback`)
 - rust-lang#121669 (Count stashed errors again)
 - rust-lang#121783 (Emitter cleanups)

r? `@ghost`
`@rustbot` modify labels: rollup
@GuillaumeGomez
Copy link
Member

It keeps getting skipped when I make rollups so just trying to see if bors somehow lost its state by re-approving it.

@bors r=Amanieu rollup

@bors
Copy link
Collaborator

bors commented Feb 29, 2024

💡 This pull request was already approved, no need to approve it again.

@bors
Copy link
Collaborator

bors commented Feb 29, 2024

📌 Commit 0de3677 has been approved by Amanieu

It is now in the queue for this repository.

@tgross35
Copy link
Contributor Author

tgross35 commented Feb 29, 2024

Foiled again! Rollup completed and everything got merged but this

@ChrisDenton
Copy link
Member

Seems like it was merged tho? 06d4878

Not sure what's going on there.

@tgross35
Copy link
Contributor Author

Ahhhh wtf Bors merged those two from before I force pushed, which is before this PR was approved. That's not right

@Amanieu
Copy link
Member

Amanieu commented Feb 29, 2024

It seems bors r+ picked up a stale commit: #119748 (comment)

Despite the force-push that was done here 25h before the r+: #119748 (comment)

@ChrisDenton
Copy link
Member

Maybe make a new PR that fixes it to be what it should have been?

You could also maybe try closing and reopening this PR but at this point I feel like maybe we should give it up as a lost cause 😔

tgross35 added a commit to tgross35/rust that referenced this pull request Feb 29, 2024
Remove aliases for `split_paths` and `join_paths` as should have been
done in <rust-lang#119748> (Bors merged the
wrong commit).
@tgross35
Copy link
Contributor Author

I just made a new PR to fix this one up #121809, indeed not worth sorting this specific one out. Just spooky 💀

@tgross35 tgross35 closed this Feb 29, 2024
@tgross35 tgross35 deleted the suggest-path-split branch February 29, 2024 19:41
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 29, 2024
… r=Amanieu

Remove doc aliases to PATH

Remove aliases for `split_paths` and `join_paths` as should have been done in <rust-lang#119748> (Bors merged the wrong commit).
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 1, 2024
Rollup merge of rust-lang#121809 - tgross35:suggest-path-split-fixup, r=Amanieu

Remove doc aliases to PATH

Remove aliases for `split_paths` and `join_paths` as should have been done in <rust-lang#119748> (Bors merged the wrong commit).
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants