[Rustdoc] Render tuple fields in structs correctly #80320

RDambrosio016 · 2020-12-23T03:26:22Z

This PR makes rustdoc render public tuple fields correctly similar to normal fields, previously no rendering would happen and the description of the field was effectively discarded.

Before:

After:

I was thinking about coloring the 0 a different color, maybe the color of primitives so it stands out more, but id like to hear opinions on that first.

rust-highfive · 2020-12-23T03:26:25Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ollie27 (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.

camelid · 2021-01-22T04:22:31Z

I was thinking about coloring the 0 a different color, maybe the color of primitives so it stands out more, but id like to hear opinions on that first.

I do think it makes sense for it to be a different color, but it seems that coloring it as a primitive might be confusing.

RDambrosio016 · 2021-01-22T15:24:21Z

I agree, but i suck at design, especially colors 😄

bors · 2021-01-22T19:20:37Z

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

camelid · 2021-01-25T03:18:01Z

r? @GuillaumeGomez

camelid · 2021-01-25T03:27:17Z

src/test/rustdoc/tuple_struct_fields.rs

@@ -0,0 +1,11 @@
+// @has tuple_struct_fields/struct.Tooople.html


Could you also add a check like:

Suggested change

// @has tuple_struct_fields/struct.Tooople.html

// @has tuple_struct_fields/struct.Tooople.html

// @has - 'Tuple Fields'

to make sure the heading is correct?

I think i added that at one point then removed it because it wasn't working (and the errors are less helpful than staring at a wall), but ill try again tomorrow 👍

(and the errors are less helpful than staring at a wall)

Yeah, htmldocck errors could use some work.

GuillaumeGomez · 2021-01-25T16:07:53Z

I was thinking about coloring the 0 a different color, maybe the color of primitives so it stands out more, but id like to hear opinions on that first.

As you see fit. I don't have a strong opinion there...

GuillaumeGomez · 2021-01-25T16:08:34Z

src/librustdoc/html/render/mod.rs

@@ -3079,21 +3079,22 @@ fn item_struct(
            _ => None,
        })
        .peekable();
-    if let doctree::Plain = s.struct_type {
+    if let doctree::Plain | doctree::Tuple = s.struct_type {


I didn't even know we could do that in rust! 😮

src/librustdoc/html/render/mod.rs

GuillaumeGomez · 2021-01-25T16:10:41Z

src/test/rustdoc/tuple_struct_fields.rs

@@ -0,0 +1,11 @@
+// @has tuple_struct_fields/struct.Tooople.html
+// @has - //span '0: usize'


Could you write more complete paths please? It's much easier when an unwanted change occur to find out where it's from in such cases.

As i stated in an earlier comment, i tried that, but the test harness kept erroring and i could not figure out why, which is why i removed it

I can help with that! :) If it's the same as a normal field, the path should look like this:

//section[@id="main"]/span[@id="structfield.0"] '0: usize'

Also, please add tests to ensure that "Tuple fields" header is there and that the fields are in the sidebar too.

GuillaumeGomez · 2021-01-25T16:10:56Z

src/test/rustdoc/tuple_struct_fields.rs

@@ -0,0 +1,11 @@
+// @has tuple_struct_fields/struct.Tooople.html
+// @has - //span '0: usize'
+// @has - 'Wow! i love tuple fields!'


GuillaumeGomez · 2021-01-25T16:11:02Z

src/test/rustdoc/tuple_struct_fields.rs

+// @has tuple_struct_fields/struct.Tooople.html
+// @has - //span '0: usize'
+// @has - 'Wow! i love tuple fields!'
+// @!has - 'I should be invisible'


camelid · 2021-01-29T00:06:59Z

Does this fix #42615? (For structs and enums.)

JohnCSimon · 2021-02-14T16:26:50Z

@RDambrosio016 - ping from triage, can you please address the merge conflict and comments from the reviewers? Thanks.

RDambrosio016 · 2021-02-14T18:04:13Z

I'll see if i can get to it today, ive just been very busy with other things and i kind of forgot about this 😅

crlf0710 · 2021-03-20T05:21:01Z

@RDambrosio016 Ping from triage, any updates on this?

JohnCSimon · 2021-04-04T16:58:25Z

@RDambrosio016 Ping from triage - unfortunately I'm going to have to close this as inactive. Please reopen this when you're ready to continue.

…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc `@camelid` (since you were involved on the original PR). r? `@jyn514`

…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc ``@camelid`` (since you were involved on the original PR). r? ``@jyn514``

…oc, r=jyn514 Add support for tuple struct field documentation Fixes rust-lang#42615. This is rust-lang#80320 updated to new codebase and with added tests. Part of rust-lang#83255. cc ```@camelid``` (since you were involved on the original PR). r? ```@jyn514```

RDambrosio016 added 2 commits December 22, 2020 22:18

Fix: render tuple fields in structs correctly

ca664b0

Chore: test for no rendering if the field is not public

bf0fd2f

rust-highfive assigned ollie27 Dec 23, 2020

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

jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 5, 2021

rust-highfive assigned GuillaumeGomez and unassigned ollie27 Jan 25, 2021

camelid added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jan 25, 2021

camelid reviewed Jan 25, 2021

View reviewed changes

GuillaumeGomez reviewed Jan 25, 2021

View reviewed changes

src/librustdoc/html/render/mod.rs Show resolved Hide resolved

GuillaumeGomez reviewed Jan 25, 2021

View reviewed changes

JohnTitor removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 2, 2021

camelid mentioned this pull request Mar 21, 2021

rustdoc: --show-coverage shouldn't count tuple struct fields #83255

Closed

JohnCSimon added the S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. label Apr 4, 2021

JohnCSimon closed this Apr 4, 2021

GuillaumeGomez mentioned this pull request Jul 25, 2021

Add support for tuple struct field documentation #87451

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rustdoc] Render tuple fields in structs correctly #80320

[Rustdoc] Render tuple fields in structs correctly #80320

RDambrosio016 commented Dec 23, 2020

rust-highfive commented Dec 23, 2020

camelid commented Jan 22, 2021

RDambrosio016 commented Jan 22, 2021

bors commented Jan 22, 2021

camelid commented Jan 25, 2021

camelid Jan 25, 2021

RDambrosio016 Jan 25, 2021 •

edited

Loading

camelid Jan 25, 2021

GuillaumeGomez commented Jan 25, 2021 •

edited

Loading

GuillaumeGomez Jan 25, 2021

GuillaumeGomez Jan 25, 2021

RDambrosio016 Jan 25, 2021

GuillaumeGomez Jan 25, 2021 •

edited

Loading

GuillaumeGomez Jan 25, 2021

GuillaumeGomez Jan 25, 2021

camelid commented Jan 29, 2021

JohnCSimon commented Feb 14, 2021

RDambrosio016 commented Feb 14, 2021

crlf0710 commented Mar 20, 2021

JohnCSimon commented Apr 4, 2021

		@@ -0,0 +1,11 @@
		// @has tuple_struct_fields/struct.Tooople.html

	// @has tuple_struct_fields/struct.Tooople.html
	// @has tuple_struct_fields/struct.Tooople.html
	// @has - 'Tuple Fields'

		@@ -0,0 +1,11 @@
		// @has tuple_struct_fields/struct.Tooople.html
		// @has - //span '0: usize'

[Rustdoc] Render tuple fields in structs correctly #80320

[Rustdoc] Render tuple fields in structs correctly #80320

Conversation

RDambrosio016 commented Dec 23, 2020

rust-highfive commented Dec 23, 2020

camelid commented Jan 22, 2021

RDambrosio016 commented Jan 22, 2021

bors commented Jan 22, 2021

camelid commented Jan 25, 2021

camelid Jan 25, 2021

Choose a reason for hiding this comment

RDambrosio016 Jan 25, 2021 • edited Loading

Choose a reason for hiding this comment

camelid Jan 25, 2021

Choose a reason for hiding this comment

GuillaumeGomez commented Jan 25, 2021 • edited Loading

GuillaumeGomez Jan 25, 2021

Choose a reason for hiding this comment

GuillaumeGomez Jan 25, 2021

Choose a reason for hiding this comment

RDambrosio016 Jan 25, 2021

Choose a reason for hiding this comment

GuillaumeGomez Jan 25, 2021 • edited Loading

Choose a reason for hiding this comment

GuillaumeGomez Jan 25, 2021

Choose a reason for hiding this comment

GuillaumeGomez Jan 25, 2021

Choose a reason for hiding this comment

camelid commented Jan 29, 2021

JohnCSimon commented Feb 14, 2021

RDambrosio016 commented Feb 14, 2021

crlf0710 commented Mar 20, 2021

JohnCSimon commented Apr 4, 2021

RDambrosio016 Jan 25, 2021 •

edited

Loading

GuillaumeGomez commented Jan 25, 2021 •

edited

Loading

GuillaumeGomez Jan 25, 2021 •

edited

Loading