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 for links to module-level docs #77870

Merged
merged 1 commit into from
Oct 14, 2020

Conversation

camelid
Copy link
Member

@camelid camelid commented Oct 12, 2020

r? @jyn514

@camelid camelid added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-cleanup Category: PRs that clean code up or issues documenting cleanup. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Oct 12, 2020
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 12, 2020
@camelid
Copy link
Member Author

camelid commented Oct 12, 2020

Note that I haven't yet checked in my browser to make sure the links are correct.

@camelid camelid changed the title Use intra-doc links for super Use intra-doc links for links to module-level docs Oct 12, 2020
library/core/src/cell.rs Outdated Show resolved Hide resolved
library/core/src/cell.rs Outdated Show resolved Hide resolved
library/core/src/cell.rs Outdated Show resolved Hide resolved
library/core/src/cell.rs Outdated Show resolved Hide resolved
library/core/src/result.rs Outdated Show resolved Hide resolved
library/std/src/path.rs Outdated Show resolved Hide resolved
library/std/src/path.rs Outdated Show resolved Hide resolved
library/core/src/iter/sources.rs Show resolved Hide resolved
library/alloc/src/alloc.rs Outdated Show resolved Hide resolved
@jyn514
Copy link
Member

jyn514 commented Oct 12, 2020

r=me with CI passing

@camelid
Copy link
Member Author

camelid commented Oct 13, 2020

I had to revert the changes to btree/{map.rs, set.rs} since the documentation linked to is in std, not alloc. Maybe it should be moved? Probably in a different PR though.

@jyn514
Copy link
Member

jyn514 commented Oct 13, 2020

I had to revert the changes to btree/{map.rs, set.rs} since the documentation linked to is in std, not alloc. Maybe it should be moved?

It can't be moved because it links to HashMap which is only in std: 4065846

@jyn514
Copy link
Member

jyn514 commented Oct 13, 2020

@bors r+

@bors
Copy link
Contributor

bors commented Oct 13, 2020

📌 Commit 95221b4 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 Oct 13, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 14, 2020
Rollup of 8 pull requests

Successful merges:

 - rust-lang#77765 (Add LLVM flags to limit DWARF version to 2 on BSD)
 - rust-lang#77788 (BTreeMap: fix gdb provider on BTreeMap with ZST keys or values)
 - rust-lang#77795 (Codegen backend interface refactor)
 - rust-lang#77808 (Moved the main `impl` for FnCtxt to its own file.)
 - rust-lang#77817 (Switch rustdoc from `clean::Stability` to `rustc_attr::Stability`)
 - rust-lang#77829 (bootstrap: only use compiler-builtins-c if they exist)
 - rust-lang#77870 (Use intra-doc links for links to module-level docs)
 - rust-lang#77897 (Move `Strip` into a separate rustdoc pass)

Failed merges:

 - rust-lang#77879 (Provide better documentation and help messages for x.py setup)
 - rust-lang#77902 (Include aarch64-pc-windows-msvc in the dist manifests)

r? `@ghost`
@bors bors merged commit ed34f82 into rust-lang:master Oct 14, 2020
@rustbot rustbot added this to the 1.49.0 milestone Oct 14, 2020
@camelid camelid deleted the intra-doc-super branch October 14, 2020 05:29
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 C-cleanup Category: PRs that clean code up or issues documenting cleanup. 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.

5 participants