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

Use intra-doc links in std::env, std::alloc and std::error #75629

Merged
merged 4 commits into from
Aug 18, 2020
Merged

Use intra-doc links in std::env, std::alloc and std::error #75629

merged 4 commits into from
Aug 18, 2020

Conversation

BoxyUwU
Copy link
Member

@BoxyUwU BoxyUwU commented Aug 17, 2020

This is partial fixes for #75080.

@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 @sfackler (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.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 17, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 17, 2020

r? @jyn514

@rust-highfive rust-highfive assigned jyn514 and unassigned sfackler Aug 17, 2020
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good after nits are fixed :)

library/std/src/env.rs Outdated Show resolved Hide resolved
library/std/src/env.rs Outdated Show resolved Hide resolved
library/std/src/env.rs Outdated Show resolved Hide resolved
library/std/src/env.rs Outdated Show resolved Hide resolved
@jyn514 jyn514 added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Aug 17, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 17, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 17, 2020

📌 Commit e7a7279 has been approved by jyn514

@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 Aug 17, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 18, 2020
Rollup of 8 pull requests

Successful merges:

 - rust-lang#75389 (attempt to improve span_label docs)
 - rust-lang#75392 (Add `as_uninit`-like methods to pointer types and unify documentation of `as_ref` methods)
 - rust-lang#75464 (Move to intra doc links for ascii.rs and panic.rs)
 - rust-lang#75578 (Allowing raw ptr dereference in const fn)
 - rust-lang#75613 (Add explanation for `&mut self` method call when expecting `-> Self`)
 - rust-lang#75626 (Clean up E0754 explanation)
 - rust-lang#75629 (Use intra-doc links in `std::env`, `std::alloc` and `std::error`)
 - rust-lang#75634 (Mark x86_64-linux-kernel as *)

Failed merges:

r? @ghost
@bors bors merged commit 732bebd into rust-lang:master Aug 18, 2020
@jyn514 jyn514 removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 25, 2020
pietroalbini added a commit to pietroalbini/rust that referenced this pull request Aug 28, 2020
Error use explicit intra-doc link and fix text

Follow up of rust-lang#75629

r? @jyn514
tmandry added a commit to tmandry/rust that referenced this pull request Sep 1, 2020
Use `env::func()`, not 'the function env::func' in docs for std::env

Follow up of rust-lang#75629

r? @jyn514
@cuviper cuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants