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

Move to intra-doc links for task.rs and vec.rs #75672

Merged
merged 2 commits into from
Aug 20, 2020

Conversation

kofls
Copy link
Contributor

@kofls kofls commented Aug 18, 2020

Partial fix for #75080

links for [get], [get_mut] skipped due to #75643
link for [copy_from_slice] skipped due to #63351

@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 @LukasKalbertodt (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 18, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 18, 2020

r? @jyn514

Comment on lines 861 to 862
/// [`truncate`]: #method.truncate
/// [`resize`]: #method.resize
Copy link
Member

Choose a reason for hiding this comment

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

These are implemented on Vec, not on slices.

Suggested change
/// [`truncate`]: #method.truncate
/// [`resize`]: #method.resize
/// [`truncate`]: Vec::truncate
/// [`resize`]: Vec::resize

@@ -867,7 +860,7 @@ impl<T> Vec<T> {
///
/// [`truncate`]: #method.truncate
/// [`resize`]: #method.resize
/// [`extend`]: ../../std/iter/trait.Extend.html#tymethod.extend
/// [`extend`]: Extend::extend
/// [`clear`]: #method.clear
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// [`clear`]: #method.clear
/// [`clear`]: Vec::clear

@@ -1480,7 +1471,6 @@ impl<T> Vec<T> {
/// ```
///
/// [`resize`]: #method.resize
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// [`resize`]: #method.resize
/// [`resize`]: Vec::resize

@@ -1590,8 +1580,6 @@ impl<T: Clone> Vec<T> {
/// assert_eq!(vec, [1, 2]);
/// ```
///
/// [`Clone`]: ../../std/clone/trait.Clone.html
/// [`Default`]: ../../std/default/trait.Default.html
/// [`resize_with`]: #method.resize_with
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// [`resize_with`]: #method.resize_with
/// [`resize_with`]: Vec::resize_with

/// [`Default::default()`]: ../../std/default/trait.Default.html#tymethod.default
/// [`Default`]: ../../std/default/trait.Default.html
/// [`Clone`]: ../../std/clone/trait.Clone.html
/// [`Default::default()`]: Default::default
Copy link
Member

Choose a reason for hiding this comment

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

The parentheses count as a disambiguator, they'll still link :)

Suggested change
/// [`Default::default()`]: Default::default

@@ -1655,9 +1643,7 @@ impl<T: Default> Vec<T> {
/// ```
///
/// [`resize`]: #method.resize
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// [`resize`]: #method.resize
/// [`resize`]: Vec::resize

@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 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 Aug 19, 2020
@jyn514 jyn514 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 20, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 20, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 20, 2020

📌 Commit 632db79 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 20, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 20, 2020
Rollup of 8 pull requests

Successful merges:

 - rust-lang#75672 (Move to intra-doc links for task.rs and vec.rs)
 - rust-lang#75702 (Clean up E0759 explanation)
 - rust-lang#75703 (Enable stack-overflow detection on musl for non-main threads)
 - rust-lang#75710 (Fix bad printing of const-eval queries)
 - rust-lang#75716 (Upgrade Emscripten on CI to 1.39.20 )
 - rust-lang#75731 (Suppress ty::Float in MIR comments of ty::Const)
 - rust-lang#75733 (Remove duplicated alloc vec bench push_all_move)
 - rust-lang#75743 (Rename rustc_lexer::TokenKind::Not to Bang)

Failed merges:

r? @ghost
@bors bors merged commit f29f212 into rust-lang:master Aug 20, 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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 24, 2023
…=thomcc

docs: use intra-doc links for `Vec::get(_mut)`

Now that rust-lang#63351 is fixed, there's no reason not to.

CC rust-lang#75672
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 25, 2023
…=thomcc

docs: use intra-doc links for `Vec::get(_mut)`

Now that rust-lang#63351 is fixed, there's no reason not to.

CC rust-lang#75672
@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