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

Update docs so that deprecated method points to relevant method #102313

Merged
merged 1 commit into from
Oct 2, 2022

Conversation

anirudh24seven
Copy link
Contributor

The docs for the deprecated 'park_timeout_ms' method suggests that the user 'use park_timeout' method instead (at https://doc.rust-lang.org/std/thread/index.html).

Making a similar change so that the docs for the deprecated sleep_ms method suggest that the user use sleep method instead.

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 26, 2022
@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 @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information.

@rustbot
Copy link
Collaborator

rustbot commented Sep 26, 2022

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

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 26, 2022
@fmease
Copy link
Member

fmease commented Sep 26, 2022

The deprecated badge already mentions that the function was “replaced by std::thread::sleep”:
IMG_20220926_162747.jpg

I am no sure what additional value your changes have (edit: apart from providing a link which arguably rustdoc should do automatically).

@anirudh24seven
Copy link
Contributor Author

As mentioned in the link above, the docs repeat the description of the function instead of being consistent with the other method (park_timeout_ms).

Hope this screenshot helps to explain my issue better.

image

@Mark-Simulacrum
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Oct 1, 2022

📌 Commit 4c42e38 has been approved by Mark-Simulacrum

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 Oct 1, 2022
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 2, 2022
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#102195 (Improve the COPYRIGHT file)
 - rust-lang#102313 (Update docs so that deprecated method points to relevant method)
 - rust-lang#102353 (Allow passing rustix_use_libc cfg using RUSTFLAGS)
 - rust-lang#102405 (Remove a FIXME whose code got moved away in rust-lang#62883.)
 - rust-lang#102525 (rustdoc: remove orphaned link on array bracket)
 - rust-lang#102557 (fix issue with x.py setup running into explicit panic)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 649c099 into rust-lang:master Oct 2, 2022
@rustbot rustbot added this to the 1.66.0 milestone Oct 2, 2022
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.

6 participants