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

Switch to intra-doc links in std::macros #75821

Merged
merged 3 commits into from
Aug 24, 2020

Conversation

camelid
Copy link
Member

@camelid camelid commented Aug 22, 2020

Part of #75080.


  • Switch to intra-doc links in std::macros
  • Fix typo in module docs
  • Link to std::io::stderr instead of std::io::Stderr to match the
    link text
  • Link to std::io::stdout

@rustbot modify labels: A-intra-doc-links T-doc T-rustdoc

Also:
* Fix typo in module docs
* Link to `std::io::stderr` instead of `std::io::Stderr` to match the
  link text
* Link to `std::io::stdout`
@rustbot rustbot added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 22, 2020
@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

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

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

camelid commented Aug 22, 2020

Should I change this line:

/// [`debug!`]: https://docs.rs/log/*/log/macro.debug.html

to this:

/// [`debug!`]: https://docs.rs/log/latest/log/macro.debug.html

since it seems clearer?

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.

r=me once nits are fixed. I don't have an opinion on the docs.rs link other than I think * looks like globbing which is kind of cute.

library/std/src/macros.rs Outdated Show resolved Hide resolved
library/std/src/macros.rs Show resolved Hide resolved
library/std/src/macros.rs Show resolved Hide resolved
@jyn514
Copy link
Member

jyn514 commented Aug 23, 2020

r? @jyn514

@camelid
Copy link
Member Author

camelid commented Aug 23, 2020

@jyn514 Should be fixed now!

@jyn514
Copy link
Member

jyn514 commented Aug 23, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 23, 2020

📌 Commit 637659b 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 23, 2020
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Aug 24, 2020
…ros, r=jyn514

Switch to intra-doc links in `std::macros`

Part of rust-lang#75080.

---

* Switch to intra-doc links in `std::macros`
* Fix typo in module docs
* Link to `std::io::stderr` instead of `std::io::Stderr` to match the
  link text
* Link to `std::io::stdout`

---

@rustbot modify labels: A-intra-doc-links T-doc T-rustdoc
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 24, 2020
Rollup of 10 pull requests

Successful merges:

 - rust-lang#75819 (Use intra-doc-links in `core::{char, macros, fmt}`)
 - rust-lang#75821 (Switch to intra-doc links in `std::macros`)
 - rust-lang#75825 (Fix typo in documentation of i32 wrapping_abs())
 - rust-lang#75826 (Corrected Misleading documentation for derived Ord/PartialOrd implementation )
 - rust-lang#75831 (doc: Prefer https link for wikipedia URLs)
 - rust-lang#75844 (publish-toolstate: show more context on HTTP error)
 - rust-lang#75847 (Switch to intra-doc links in `std::collections`)
 - rust-lang#75851 (Switch to intra-doc links in `core::array`)
 - rust-lang#75856 (more tool clippy fixes)
 - rust-lang#75859 (doc: Fix typo in std::process::Child documentation)

Failed merges:

r? @ghost
@bors bors merged commit 640b36f into rust-lang:master Aug 24, 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
@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.

7 participants