More intra doc links #77875

poliorcetics · 2020-10-12T22:55:02Z

Helps with #75080.

I did a commit by group of file, I can squash if wanted.

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

library/core/src/cell.rs

jyn514 · 2020-10-12T23:26:37Z

library/core/src/char/methods.rs

    /// # Safety
    ///
    /// This function is unsafe, as it may construct invalid `char` values.
    ///
    /// For a safe version of this function, see the [`from_u32`] function.
    ///
-    /// [`from_u32`]: #method.from_u32
+    /// [`from_u32`]: prim@char::from_u32()


Oof, this is a bug in intra-doc links. prim should apply to the whole item, not to the type.

warning: incompatible link kind for `char::from_u32` --> tmp.rs:1:6 | 1 | /// [char::from_u32()] | ^^^^^^^^^^^^^^^^ help: to link to the builtin type, prefix with `prim@`: `prim@char::from_u32` = note: this link resolved to a builtin type, which is not a function

That said, I guess it works as-is, it's just inconsistent with the rest of intra-doc links ... @Manishearth what do you think? I think if we made it apply to the whole item there'd be no way to disambiguate between primitives and modules for associated items.

Hmm, I think it could still use core::primitive::char::from_u32 actually. That seems better anyway to remove the ambiguity.

I didn't know core::primitive existed when I added prim@ ... maybe we should just get rid of that disambiguator altogether to be consistent with rustc_resolve?

If you end up using core::primitive please ping me so I can update intraconv :)

library/core/src/ptr/const_ptr.rs

library/core/src/ptr/mut_ptr.rs

jyn514 · 2020-10-13T13:23:56Z

Oh sorry - the current failures are another bug that was recently fixed: #77267. I guess this has to wait until the beta bump then :/

poliorcetics · 2020-10-25T15:36:22Z

Now that #77267 has been closed, I rebased on master to see if this is now working.

poliorcetics · 2020-10-25T16:00:15Z

This fails on the crate::primitive::char:: links in core because it seems rustdoc is not generating the links when in core

core::primitive -> The links do not exist.
std::primitive -> The links exist.

bors · 2020-11-08T16:33:06Z

☔ The latest upstream changes (presumably #78874) made this pull request unmergeable. Please resolve the merge conflicts.

Note that reviewers usually do not review pull requests until merge conflicts are resolved! Once you resolve the conflicts, you should change the labels applied by bors to indicate that your PR is ready for review. Post this as a comment to change the labels:

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

poliorcetics · 2020-11-19T13:55:36Z

I couldn't transform links like those so I simply let them as they are for now so that this PR can be merged

-    /// [`len_utf8()`]: #method.len_utf8
+    /// [`len_utf8()`]: crate::primitive::char::len_utf8()
OR
+    /// [`len_utf8()`]: prim@char::len_utf8()
OR
+    /// [`len_utf8()`]: char::len_utf8()

jyn514 · 2020-11-19T17:14:54Z

It looks like this is still broken unfortunately.

std/primitive.f64.html:705: broken link - std/prim@f64::to_be_bytes()
std/primitive.f64.html:705: broken link - std/prim@f64::to_le_bytes()
std/primitive.f64.html:719: broken link - std/prim@f64::to_ne_bytes()
std/primitive.f64.html:745: broken link - std/prim@f64::from_be_bytes()
std/primitive.f64.html:745: broken link - std/prim@f64::from_le_bytes()
std/string/struct.String.html:1981: broken link - std/string/prim@str::to_ascii_uppercase()
std/string/struct.String.html:1993: broken link - std/string/prim@str::to_ascii_lowercase()
std/primitive.f32.html:728: broken link - std/prim@f32::to_be_bytes()
std/primitive.f32.html:728: broken link - std/prim@f32::to_le_bytes()
std/primitive.f32.html:742: broken link - std/prim@f32::to_ne_bytes()
std/primitive.f32.html:768: broken link - std/prim@f32::from_be_bytes()
std/primitive.f32.html:768: broken link - std/prim@f32::from_le_bytes()
std/primitive.str.html:1223: broken link - std/prim@str::to_ascii_uppercase()
std/primitive.str.html:1235: broken link - std/prim@str::to_ascii_lowercase()
std/cell/struct.RefCell.html:154: broken link - std/cell/Self::borrow_mut()
std/cell/struct.RefCell.html:156: broken link - std/cell/Self::borrow_mut()
std/cell/struct.RefCell.html:166: broken link - std/cell/Self::get_mut()
std/cell/struct.UnsafeCell.html:150: broken link - std/cell/Self::get()
thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:109:9

poliorcetics · 2020-11-23T08:48:38Z

@rustbot modify labels: +S-waiting-on-review -S-waiting-on-author

jyn514

r=me with Cargo.lock updated

Cargo.lock

jyn514 · 2020-11-29T01:07:06Z

std/cell/struct.RefCell.html:166: broken link - std/cell/Self::get_mut()

I think this might be fixed by #76467. I'll add a test case.

jyn514 · 2020-11-30T21:54:38Z

@bors r+

Thanks for sticking with this!

bors · 2020-11-30T21:54:41Z

📌 Commit 5bdd640 has been approved by jyn514

bors · 2020-11-30T22:23:03Z

⌛ Testing commit 5bdd640 with merge 796a2a9bbe7614610bd67d4cd0cf0dfff0468778...

bors · 2020-12-01T02:38:03Z

💥 Test timed out

jyn514 · 2020-12-01T02:45:21Z

@bors retry

bors · 2020-12-01T02:45:30Z

⌛ Testing commit 5bdd640 with merge becec6d...

bors · 2020-12-01T04:53:33Z

☀️ Test successful - checks-actions
Approved by: jyn514
Pushing becec6d to master...

rust-highfive assigned jyn514 Oct 12, 2020

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 labels Oct 12, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 12, 2020

jyn514 reviewed Oct 12, 2020

View reviewed changes

pitaj mentioned this pull request Oct 16, 2020

Use Intra-doc links for std::io::buffered #78006

Merged

poliorcetics force-pushed the more-intra-doc-links branch from 4609ddf to d7fc2f8 Compare October 25, 2020 15:35

poliorcetics mentioned this pull request Oct 25, 2020

no_std crates do not link to primitives #73423

Closed

poliorcetics force-pushed the more-intra-doc-links branch from d7fc2f8 to 4f50d0a Compare November 9, 2020 22:31

This comment has been minimized.

Sign in to view

jyn514 added 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 Nov 23, 2020

poliorcetics force-pushed the more-intra-doc-links branch from d558e60 to 1735a42 Compare November 23, 2020 08:48

rustbot 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 Nov 23, 2020

jyn514 approved these changes Nov 29, 2020

View reviewed changes

Cargo.lock Outdated Show resolved Hide resolved

jyn514 added 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 Nov 29, 2020

This was referenced Nov 29, 2020

Fix intra-doc links for Self on cross-crate items and primitives #76467

Merged

Doc links should count as a "use" with respect to the unused_imports lint #79542

Closed

poliorcetics added 2 commits November 30, 2020 21:18

Intra doc links for cell.rs

19fb4fe

Intra doc links for the char primitive

0bf4aaf

poliorcetics added 9 commits November 30, 2020 21:18

Intra doc links for str/mod.rs

9c27ccf

Intra doc links for the pointer primitive

4e54b4c

Intra doc links for f32/f64

b3b1e0c

Intra doc links for iterator adapters

b702060

Use Self:: in links

a5726eb

Use core::primitive module instead of prim@

ac8d117

ptr links

af40c04

Back to #method for links on char

c0560c2

Fix several broken links in doc that used the wrong qualifier or Self::

5bdd640

poliorcetics force-pushed the more-intra-doc-links branch from 1735a42 to 5bdd640 Compare November 30, 2020 20:21

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 30, 2020

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Dec 1, 2020

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 Dec 1, 2020

bors added the merged-by-bors This PR was explicitly merged by bors. label Dec 1, 2020

bors merged commit becec6d into rust-lang:master Dec 1, 2020

rustbot added this to the 1.50.0 milestone Dec 1, 2020

poliorcetics deleted the more-intra-doc-links branch December 1, 2020 10:26

jyn514 mentioned this pull request Dec 31, 2020

Rustdoc treats primitive disambiguators incorrectly #80559

Closed

poliorcetics mentioned this pull request Jan 7, 2021

Tracking Issue for intra-doc links in libstd #75080

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More intra doc links #77875

More intra doc links #77875

poliorcetics commented Oct 12, 2020

jyn514 Oct 12, 2020

jyn514 Oct 12, 2020

poliorcetics Oct 25, 2020

jyn514 commented Oct 13, 2020

poliorcetics commented Oct 25, 2020

poliorcetics commented Oct 25, 2020

bors commented Nov 8, 2020

poliorcetics commented Nov 19, 2020

jyn514 commented Nov 19, 2020

This comment has been minimized.

poliorcetics commented Nov 23, 2020

jyn514 left a comment

jyn514 commented Nov 29, 2020

jyn514 commented Nov 30, 2020

bors commented Nov 30, 2020

bors commented Nov 30, 2020

bors commented Dec 1, 2020

jyn514 commented Dec 1, 2020

bors commented Dec 1, 2020

bors commented Dec 1, 2020

More intra doc links #77875

More intra doc links #77875

Conversation

poliorcetics commented Oct 12, 2020

jyn514 Oct 12, 2020

Choose a reason for hiding this comment

jyn514 Oct 12, 2020

Choose a reason for hiding this comment

poliorcetics Oct 25, 2020

Choose a reason for hiding this comment

jyn514 commented Oct 13, 2020

poliorcetics commented Oct 25, 2020

poliorcetics commented Oct 25, 2020

bors commented Nov 8, 2020

poliorcetics commented Nov 19, 2020

jyn514 commented Nov 19, 2020

This comment has been minimized.

poliorcetics commented Nov 23, 2020

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 commented Nov 29, 2020

jyn514 commented Nov 30, 2020

bors commented Nov 30, 2020

bors commented Nov 30, 2020

bors commented Dec 1, 2020

jyn514 commented Dec 1, 2020

bors commented Dec 1, 2020

bors commented Dec 1, 2020