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

Correct std::prelude comment #106456

Merged
merged 1 commit into from
Apr 27, 2023
Merged

Conversation

kadiwa4
Copy link
Contributor

@kadiwa4 kadiwa4 commented Jan 4, 2023

(Read the changed file first for context.)

First, alloc has no prelude.

Second, the docs for v1 don't matter since the prelude module already has all the doc links. The rust_2021 module for instance also doesnt have a convenient doc page. However as I understand glob imports still cant be used because the items dont have the same stabilisation versions.

@rustbot
Copy link
Collaborator

rustbot commented Jan 4, 2023

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 4, 2023
@rustbot
Copy link
Collaborator

rustbot commented Jan 4, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@jyn514
Copy link
Member

jyn514 commented Apr 27, 2023

r? jyn514

Looks like the alloc prelude was removed in 8007dfa, good catch.

Second, the docs for v1 don't matter since the prelude module already has all the doc links. The rust_2021 module for instance also doesnt have a convenient doc page. However as I understand glob imports still cant be used because the items dont have the same stabilisation versions.

I don't think this is accurate? 2021 has a page right here: https://doc.rust-lang.org/std/prelude/rust_2021/index.html
and v1 has a page as well: https://doc.rust-lang.org/std/prelude/v1/index.html
so I think the old comment was correct at least for that part.

@rustbot rustbot assigned jyn514 and unassigned joshtriplett Apr 27, 2023
@jyn514 jyn514 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 Apr 27, 2023
@kadiwa4
Copy link
Contributor Author

kadiwa4 commented Apr 27, 2023

Thanks for reviving my PRs!

I don't think this is accurate? 2021 has a page right here: https://doc.rust-lang.org/std/prelude/rust_2021/index.html

What I meant was that that page is a pain to navigate and people are probably gonna use the std::prelude docs instead. Because the std::prelude docs are generally more convenient than the v1 ones, it doesnt matter if that module page shows a complete list or only shows a glob import.

But I can revert that change if you disagree with it

@jyn514
Copy link
Member

jyn514 commented Apr 27, 2023

I'd like to revert that change, yes, I think it's important for the v1 links to point to std even if it's rare to look at them.

Happy to approve when that's done :)

@jyn514
Copy link
Member

jyn514 commented Apr 27, 2023

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 27, 2023

📌 Commit 60ab69d has been approved by jyn514

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 27, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 27, 2023
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#105745 (docs(std): clarify remove_dir_all errors)
 - rust-lang#106456 (Correct `std::prelude` comment)
 - rust-lang#106599 (Change memory ordering in System wrapper example)
 - rust-lang#110838 (More `Typefoldable`/`TypeVisitable` cleanups)
 - rust-lang#110851 (compiletest: emit assembly-output header in error)
 - rust-lang#110853 (compiletest: add bpf-linker assembly support)
 - rust-lang#110878 (Add `known-bug` tests for 4 unsound issues)
 - rust-lang#110886 (`DepGraph` cleanups)
 - rust-lang#110905 (Remove invalid value from scraped-examples.md)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit aa22867 into rust-lang:master Apr 27, 2023
@rustbot rustbot added this to the 1.71.0 milestone Apr 27, 2023
@kadiwa4 kadiwa4 deleted the std-prelude-comment branch April 28, 2023 06:18
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. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants