Skip to content

Add support for tuple struct field documentation - #87451

Merged
bors merged 5 commits into
rust-lang:masterfrom
GuillaumeGomez:tuple-struct-field-doc
Jul 29, 2021
Merged

Add support for tuple struct field documentation#87451
bors merged 5 commits into
rust-lang:masterfrom
GuillaumeGomez:tuple-struct-field-doc

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Jul 25, 2021•
edited
Loading

Copy link
Copy Markdown
Member

Fixes#42615.
This is #80320 updated to new codebase and with added tests.
Part of #83255.

cc @camelid (since you were involved on the original PR).
r? @jyn514

@GuillaumeGomezGuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 25, 2021
@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 25, 2021
@jyn514

jyn514 commented Jul 25, 2021

Copy link
Copy Markdown
Member

This closes #42615, right? I'm not sure how the --show-coverage issue is related.

jyn514
jyn514 reviewed Jul 25, 2021
View reviewed changes
Comment threadsrc/test/rustdoc/tuple-struct-fields-doc.rs Outdated
@jyn514jyn514 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 Jul 25, 2021
@GuillaumeGomez

GuillaumeGomez commented Jul 25, 2021

Copy link
Copy Markdown
MemberAuthor

This closes #42615, right? I'm not sure how the --show-coverage issue is related.

Absolutely! As for the --show-coverage issue: it's because it complains about missing documentation on tuple structs' fields which currently can't be documented. ;)

@GuillaumeGomez
GuillaumeGomezforce-pushed the tuple-struct-field-doc branch from 3cdd340 to c987faeCompareJuly 25, 2021 19:20
@GuillaumeGomez

GuillaumeGomez commented Jul 25, 2021

Copy link
Copy Markdown
MemberAuthor

Added support for tuple structs in enums as well. Great catch @jyn514 !

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the tuple-struct-field-doc branch from c987fae to 52cb21bCompareJuly 25, 2021 20:12
jyn514
jyn514 reviewed Jul 26, 2021
View reviewed changes
Comment threadsrc/librustdoc/clean/mod.rs Outdated
Comment threadsrc/librustdoc/clean/mod.rs Outdated
Comment threadsrc/librustdoc/clean/types.rs Outdated
camelid
camelid reviewed Jul 26, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/print_item.rs Outdated
Comment threadsrc/librustdoc/html/render/print_item.rs Outdated
@GuillaumeGomez
GuillaumeGomezforce-pushed the tuple-struct-field-doc branch from 52cb21b to 74e20ecCompareJuly 26, 2021 08:59
@GuillaumeGomez

GuillaumeGomez commented Jul 26, 2021

Copy link
Copy Markdown
MemberAuthor

Updated!

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the tuple-struct-field-doc branch from 74e20ec to fbf78e1CompareJuly 26, 2021 09:15
@GuillaumeGomez

GuillaumeGomez commented Jul 26, 2021

Copy link
Copy Markdown
MemberAuthor

And of course I forgot rustfmt...

@jyn514

jyn514 commented Jul 27, 2021

Copy link
Copy Markdown
Member

r=me with the comment added :)

@GuillaumeGomez

GuillaumeGomez commented Jul 27, 2021

Copy link
Copy Markdown
MemberAuthor

@bors: r=jyn514

@bors

bors commented Jul 27, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit c4aa735 has been approved by jyn514

@borsbors 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 Jul 27, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jul 27, 2021
@GuillaumeGomez
Rollup merge ofrust-lang#87451- GuillaumeGomez:tuple-struct-field-d…
c5e23cf
…oc, r=jyn514
Add support for tuple struct field documentation
Fixesrust-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`
@GuillaumeGomezGuillaumeGomez mentioned this pull request Jul 27, 2021
Closed
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Jul 28, 2021
@JohnTitor
Rollup merge ofrust-lang#87451- GuillaumeGomez:tuple-struct-field-d…
0a92db3
…oc, r=jyn514
Add support for tuple struct field documentation
Fixesrust-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``
This was referenced Jul 28, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 28, 2021
@bors
Auto merge ofrust-lang#87569- JohnTitor:rollup-7ydfetw, r=JohnTitor
4533be9
Rollup of 10 pull requests
Successful merges:
- rust-lang#81050 (Stabilize core::task::ready!)
- rust-lang#81363 (Remove P: Unpin bound on impl Future for Pin)
- rust-lang#86839 (Add doc aliases to fs.rs)
- rust-lang#87435 (fix example code for E0617)
- rust-lang#87451 (Add support for tuple struct field documentation)
- rust-lang#87491 (Integrate context into the memorial to Anna)
- rust-lang#87521 (Add long explanation for E0498)
- rust-lang#87527 (Don't run MIR unsafeck at all when using `-Zthir-unsafeck`)
- rust-lang#87550 (Add `CI_ONLY_WHEN_CHANNEL` and run `x86_64-gnu-stable` only on nightly)
- rust-lang#87565 (Use backticks when referring to `core::future::Ready` in panic message)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 014e22c into rust-lang:masterJul 29, 2021
@rustbotrustbot added this to the 1.56.0 milestone Jul 29, 2021
@GuillaumeGomez
GuillaumeGomez deleted the tuple-struct-field-doc branch July 29, 2021 08:14
@jyn514jyn514 added the relnotes Marks issues that should be documented in the release notes of the next release. label Jul 30, 2021
@GuillaumeGomezGuillaumeGomez mentioned this pull request Aug 3, 2021
Closed
dsherret
dsherret reviewed Aug 9, 2021
View reviewed changes
Comment threadsrc/librustdoc/clean/mod.rs
// (even for a tuple struct variant!), it's simpler to just store it as a
// `Variant::Struct` instead of a `Variant::Tuple` (otherwise it would force us to make
// a lot of changes when rendering them to generate the name as well).
hir::VariantData::Tuple(..) => Variant::Struct(self.clean(cx)),

@dsherretdsherretAug 9, 2021•
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Did this cause #87887?

It seems like tuple variants no longer exist in the outputted json, but shouldn't tuple variants be described as tuple variants?

@GuillaumeGomezGuillaumeGomezAug 9, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

It's very likely yes.

@camelidcamelid mentioned this pull request Aug 9, 2021
Closed
@camelidcamelid mentioned this pull request Sep 5, 2021
Merged
@Mark-SimulacrumMark-Simulacrum mentioned this pull request Sep 12, 2021
Merged
Manishearth added a commit to Manishearth/rust that referenced this pull request Sep 24, 2021
@Manishearth
Rollup merge ofrust-lang#88893- Mark-Simulacrum:relnotes, r=pietroa…
790dc54
…lbini
Add 1.56.0 release notes
Notable things:
* Rustdoc section currently absent, for lack of things to call out that I could find. It seems like rust-lang#87451 is the only potential candidate, but that seems like more of a bugfix and doesn't seem to warrant inclusion to me. But we can add it if desired.
As with the 1.55.0 release notes, my intent is to leave this open for approximately 1-2 weeks at the early part of the cycle, and then merge it in (after fixing any feedback). Further iteration can happen in subsequent issues (and PRs).
[Rendered](https://github.com/Mark-Simulacrum/rust/blob/relnotes/RELEASES.md)
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Sep 24, 2021
@workingjubilee
Rollup merge ofrust-lang#88893- Mark-Simulacrum:relnotes, r=pietroa…
2de7f10
…lbini
Add 1.56.0 release notes
Notable things:
* Rustdoc section currently absent, for lack of things to call out that I could find. It seems like rust-lang#87451 is the only potential candidate, but that seems like more of a bugfix and doesn't seem to warrant inclusion to me. But we can add it if desired.
As with the 1.55.0 release notes, my intent is to leave this open for approximately 1-2 weeks at the early part of the cycle, and then merge it in (after fixing any feedback). Further iteration can happen in subsequent issues (and PRs).
[Rendered](https://github.com/Mark-Simulacrum/rust/blob/relnotes/RELEASES.md)
@tbillingtontbillington mentioned this pull request Mar 14, 2024
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Aug 2, 2026
Merged
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@camelidcamelidcamelid left review comments
+2 more reviewers
@dsherretdsherretdsherret left review comments
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@jyn514jyn514

Labels

relnotesMarks issues that should be documented in the release notes of the next release.S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.56.0

Development

Successfully merging this pull request may close these issues.

Rustdoc should pick up docs for tuple struct and enum fields

8 participants

@GuillaumeGomez@jyn514@rust-log-analyzer@bors@dsherret@camelid@rust-highfive@rustbot