Skip to content

Commit

Permalink
Fix broken doc link to tokio_stream::Stream (#2271)
Browse files Browse the repository at this point in the history
* Fix broken doc link to `Stream`

This commit fixes broken doc link to `Stream` in codegen clients. That
target is `tokio_stream::Stream`, which in turn is a re-export of
`futures_core::Stream`. Since we do not have a good way to link to the
re-export, we remove a hyper link and just put `Stream`.

* Update CHANGELOG.next.toml

---------

Co-authored-by: Yuki Saito <awsaito@amazon.com>
  • Loading branch information
ysaito1001 and ysaito1001 authored Feb 2, 2023
1 parent 9b7c065 commit ac7fdf2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions CHANGELOG.next.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,15 @@ Add static stability support to IMDS credentials provider. It does not alter com
references = ["smithy-rs#2258"]
meta = { "breaking" = false, "tada" = true, "bug" = false }
author = "ysaito1001"

[[smithy-rs]]
message = "Fix broken doc link for `tokio_stream::Stream` that is a re-export of `futures_core::Stream`."
references = ["smithy-rs#2271"]
meta = { "breaking" = false, "tada" = false, "bug" = true, "target" = "client"}
author = "ysaito1001"

[[aws-sdk-rust]]
message = "Fix broken doc link for `tokio_stream::Stream` that is a re-export of `futures_core::Stream`."
references = ["smithy-rs#2271"]
meta = { "breaking" = false, "tada" = false, "bug" = true }
author = "ysaito1001"
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ class FluentClientGenerator(
"""
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](#{Paginator}::send) which returns a [`Stream`](tokio_stream::Stream).
/// Paginators are used by calling [`send().await`](#{Paginator}::send) which returns a `Stream`.
pub fn into_paginator(self) -> #{Paginator}${generics.inst} {
#{Paginator}::new(self.handle, self.inner)
}
Expand Down

0 comments on commit ac7fdf2

Please sign in to comment.