Skip to content

Rustdoc: Surface trait impl doc comments in "implemented" section #18701

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

Closed
sfackler opened this issue Nov 6, 2014 · 5 comments
Closed

Rustdoc: Surface trait impl doc comments in "implemented" section #18701

sfackler opened this issue Nov 6, 2014 · 5 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@sfackler
Copy link
Member

sfackler commented Nov 6, 2014

rust-postgres is going to be providing more built-in implementations of ToSql and FromSql for third part libraries via Cargo features (e.g. sfackler/rust-postgres@4f80c32). I've tagged the trait impls with a doc comment stating which feature is required to use them (sfackler/rust-postgres@b81acaa), but that comment isn't displayed by rustdoc: http://sfackler.github.io/doc/postgres/trait.ToSql.html.

@sfackler sfackler added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Nov 6, 2014
@sfackler
Copy link
Member Author

sfackler commented Nov 6, 2014

cc @alexcrichton

@sfackler sfackler changed the title Rustdoc: Surface impl doc comments in "implemented" section Rustdoc: Surface trait impl doc comments in "implemented" section Nov 6, 2014
@jan-hudec
Copy link

Note that the comments do appear in the “Trait implementations” section of the type's documentation. But for libraries that define new traits and implement them for existing types this is useful. The comments have to also appear in the “Implementors” section trait's documentation because depending on whether new type or new trait is being created the crate may be only generating one of these pages.

@sfackler
Copy link
Member Author

This has been a persistent source of confusion for users of rust-postgres:
sfackler/rust-postgres#121
sfackler/rust-postgres#120
sfackler/rust-postgres#112
sfackler/rust-postgres#103
sfackler/rust-postgres#102

@steveklabnik
Copy link
Member

Triage: no change.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 22, 2017
@QuietMisdreavus QuietMisdreavus self-assigned this Aug 1, 2017
@ehuss ehuss removed the T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. label Jan 18, 2022
@Dylan-DPC
Copy link
Member

closing this issue after a discussion with @GuillaumeGomez

@Dylan-DPC Dylan-DPC closed this as not planned Won't fix, can't repro, duplicate, stale Nov 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

7 participants