-
Notifications
You must be signed in to change notification settings - Fork 13.3k
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
Comments
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. |
This has been a persistent source of confusion for users of rust-postgres: |
Triage: no change. |
closing this issue after a discussion with @GuillaumeGomez |
rust-postgres
is going to be providing more built-in implementations ofToSql
andFromSql
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.The text was updated successfully, but these errors were encountered: