Add missing documentation for std::char types #87618

GuillaumeGomez · 2021-07-30T09:25:58Z

No description provided.

rust-highfive · 2021-07-30T09:26:01Z

r? @kennytm

(rust-highfive has picked a reviewer for you, use r? to override)

library/core/src/char/convert.rs

GuillaumeGomez · 2021-08-03T08:39:44Z

I forgot that we don't support anchors for primitive types yet... Needs to wait for #87073 to be merged.

GuillaumeGomez · 2021-09-13T13:03:14Z

@jyn514: ^ wasn't this restriction lifted?

jyn514 · 2021-09-13T13:37:33Z

@GuillaumeGomez it needs to wait for the bootstrap compiler to be bumped, so another 6 weeks. To avoid waiting longer (e.g. if it turns out rustdoc is buggy), you could run x.py doc --stage 1 library/std to make sure it will work at that time.

(You can avoid having to build rustc from source by setting download-rustc = true and using --stage 2.)

GuillaumeGomez · 2021-09-13T13:41:38Z

I did and it worked, which is why I was confused. Well, let's wait for 6 weeks then!

jyn514 · 2021-11-09T10:02:46Z

@GuillaumeGomez it's been 6 weeks :)

GuillaumeGomez · 2021-11-10T10:25:03Z

Let's see! :D

GuillaumeGomez · 2021-11-10T11:05:00Z

library/core/src/char/convert.rs

@@ -199,6 +199,8 @@ impl const From<u8> for char {
 }

 /// An error which can be returned when parsing a char.
+///
+/// This `struct` is created when using the [`char::from_str`](char#tymethod.from_str) method.


I think it's still not ready:

warning: unresolved link to `char::from_str` --> foo.rs:1:7 | 1 | /// [`char::from_str`] | ^^^^^^^^^^^^^^ the builtin type `char` has no associated item named `from_str`

We need #90703 to be fixed first.

Wait, this doesn't match the error above though. The CI failure resolved the link correctly, it's just a dead link for some reason. What version of rustdoc did you use to test locally? Does the error change if you use beta?

Oh, it's because you used a fragment link instead of an intra-doc link.

Yes, which is invalid too. I'll update the current code but even the fixed version is broken for the moment.

camelid · 2022-03-06T01:34:25Z

We need #90703 to be fixed first.

#90703 is fixed now. I think this PR is no longer blocked?

GuillaumeGomez · 2022-03-07T12:58:37Z

Let's give it another try!

GuillaumeGomez · 2022-03-08T14:15:47Z

Seems like the CI passed this time. \o/

GuillaumeGomez · 2022-03-11T18:29:58Z

Forgot to r+ it...

@bors: r=jyn514,camelid

bors · 2022-03-11T18:29:59Z

📌 Commit 5b5649f has been approved by jyn514,camelid

Rollup of 7 pull requests Successful merges: - rust-lang#87618 (Add missing documentation for std::char types) - rust-lang#94769 (Collapse blanket and auto-trait impls by default) - rust-lang#94798 (`parse_tt` refactorings) - rust-lang#94818 (Rename `IntoFuture::Future` to `IntoFuture::IntoFuture`) - rust-lang#94827 (CTFE/Miri: detect out-of-bounds pointers in offset_from) - rust-lang#94838 (Make float parsing docs more comprehensive) - rust-lang#94839 (Suggest using double colon when a struct field type include single colon) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

GuillaumeGomez added T-libs-api Relevant to the library API 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 Jul 30, 2021

rust-highfive assigned kennytm Jul 30, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 30, 2021

GuillaumeGomez changed the title ~~Add missing document for std::char types~~ Add missing documentation for std::char types Jul 30, 2021

GuillaumeGomez force-pushed the std-char-types-doc branch from 0cfb99e to 76bb9d0 Compare July 30, 2021 09:26