From ac7fdf21c09b87f4eb271c94c99d97a8aa94d53b Mon Sep 17 00:00:00 2001 From: ysaito1001 Date: Thu, 2 Feb 2023 12:56:29 -0600 Subject: [PATCH] Fix broken doc link to `tokio_stream::Stream` (#2271) * 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 --- CHANGELOG.next.toml | 12 ++++++++++++ .../generators/client/FluentClientGenerator.kt | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml index ba9d47940..17d7d0ef0 100644 --- a/CHANGELOG.next.toml +++ b/CHANGELOG.next.toml @@ -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" diff --git a/codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt b/codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt index a1e1c7395..d5b8ebd94 100644 --- a/codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt +++ b/codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt @@ -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) } -- GitLab