Add support for tuple struct field documentation #87451
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GuillaumeGomez
added
the
T-rustdoc
rust-highfive
added
the
S-waiting-on-review
|
This closes #42615, right? I'm not sure how the --show-coverage issue is related. |
jyn514
reviewed
Jul 25, 2021
jyn514
added
S-waiting-on-author
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
force-pushed
the
tuple-struct-field-doc
branch
from
3cdd340 to
c987fae
Compare
|
Added support for tuple structs in enums as well. Great catch @jyn514 ! |
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
tuple-struct-field-doc
branch
from
c987fae to
52cb21b
Compare
jyn514
reviewed
Jul 26, 2021
camelid
reviewed
Jul 26, 2021
GuillaumeGomez
force-pushed
the
tuple-struct-field-doc
branch
from
52cb21b to
74e20ec
Compare
|
Updated! |
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
tuple-struct-field-doc
branch
from
74e20ec to
fbf78e1
Compare
|
And of course I forgot rustfmt... |
|
r=me with the comment added :) |
…uple for tuple structs in enums
|
@bors: r=jyn514 |
|
📌 Commit c4aa735 has been approved by |
bors
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Jul 27, 2021
…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`
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Jul 28, 2021
…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``
This was referenced Jul 28, 2021
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jul 28, 2021
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
jyn514
added
the
relnotes
dsherret
reviewed
Aug 9, 2021
| // (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)), |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
It's very likely yes.
Manishearth
added a commit
to Manishearth/rust
that referenced
this pull request
Sep 24, 2021
…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
…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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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