aws-sdk-rust icon indicating copy to clipboard operation
aws-sdk-rust copied to clipboard

Broken Link in smithy-http byte_stream

Open decatur opened this issue 3 years ago • 1 comments

What is the problem?

The link in line 136 of
https://github.com/awslabs/aws-sdk-rust/blob/main/sdk/aws-smithy-http/src/byte_stream.rs

[`impl Stream`](futures_core::Stream)

is broken, as it expands to https://docs.rs/aws-sdk-s3/0.4.0/aws_sdk_s3/futures_core::Stream

Instead, it should point to the futures-rs library.

Version

main

Platform

na

AWS Services

No response

Description

No response

Logs

No response

decatur avatar Feb 20 '22 10:02 decatur

I think this might be a bug in rustdoc, so I went ahead and filed it.

We could potentially mark these re-exports as #[doc(no_inline)], but I think that will make it less obvious that the types can be imported from the service crates rather than having to add a dependency on, say, aws-smithy-http to get them. When they're not inlined, all the links from the client builder functions end up linking to aws-smithy-http rather than the local re-export.

jdisanti avatar Feb 25 '22 02:02 jdisanti