Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rustdoc should pick up docs for tuple struct and enum fields #42615

Closed
TedDriggs opened this issue Jun 12, 2017 · 2 comments · Fixed by #87451
Closed

Rustdoc should pick up docs for tuple struct and enum fields #42615

TedDriggs opened this issue Jun 12, 2017 · 2 comments · Fixed by #87451
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@TedDriggs
Copy link

Rustdoc should expose doc comments written on tuple fields:

pub struct Foo(
    /// Hello docs
    String
);

Tagging @QuietMisdreavus @GuillaumeGomez based on conversation on IRC.

@hcpl
Copy link

hcpl commented Jun 12, 2017

This issue also applies to tuple variant fields:

pub enum Bar {
    BarVariant(
        /// Hello docs
        String
    ),
}

@QuietMisdreavus QuietMisdreavus added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 12, 2017
@Mark-Simulacrum Mark-Simulacrum added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 12, 2017
@GuillaumeGomez
Copy link
Member

It promises to be very interesting from a design point of view. We'll to think about how to render this nicely.

@Mark-Simulacrum Mark-Simulacrum added the C-bug Category: This is a bug. label Jul 27, 2017
@jyn514 jyn514 removed the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label Jul 25, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue 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 issue 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``
@bors bors closed this as completed in 014e22c Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants