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

Generated code produces cargo doc warnings #1129

Closed
jdisanti opened this issue Jan 27, 2022 · 0 comments · Fixed by #1142
Closed

Generated code produces cargo doc warnings #1129

jdisanti opened this issue Jan 27, 2022 · 0 comments · Fixed by #1142
Labels
bug Something isn't working

Comments

@jdisanti
Copy link
Collaborator

jdisanti commented Jan 27, 2022

Observed in https://github.com/awslabs/aws-sdk-rust/runs/4971673212:

 Documenting aws-sdk-chime v0.6.0 (/home/runner/work/aws-sdk-rust/aws-sdk-rust/sdk/chime)
warning: unresolved link to `self::client::fluent_builders::BatchCreateChannelMembership::r`
   --> src/client.rs:157:47
    |
157 | ...e(ChannelMembershipType)`](crate::client::fluent_builders::BatchCreateChannelMembership::r#type) / [`set_type(Option<ChannelMembership...
    |                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `BatchCreateChannelMembership` has no field or associated item named `r`
    |
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

warning: unresolved link to `self::client::fluent_builders::CreateChannelMembership::r`
   --> src/client.rs:345:47
    |
345 | ...ype(ChannelMembershipType)`](crate::client::fluent_builders::CreateChannelMembership::r#type) / [`set_type(Option<ChannelMembershipTyp...
    |                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `CreateChannelMembership` has no field or associated item named `r`

warning: unresolved link to `self::client::fluent_builders::ListChannelMemberships::r`
    --> src/client.rs:1530:47
     |
1530 | ...ype(ChannelMembershipType)`](crate::client::fluent_builders::ListChannelMemberships::r#type) / [`set_type(Option<ChannelMembershipType...
     |                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `ListChannelMemberships` has no field or associated item named `r`

warning: unresolved link to `self::client::fluent_builders::SendChannelMessage::r`
    --> src/client.rs:2112:44
     |
2112 | ...[`r#type(ChannelMessageType)`](crate::client::fluent_builders::SendChannelMessage::r#type) / [`set_type(Option<ChannelMessageType>)`](...
     |                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `SendChannelMessage` has no field or associated item named `r`

warning: 4 warnings emitted

The r# needs to be omitted for doc links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant