From 9dc97be6863369caf8c2f7dfba4015dbe640ea89 Mon Sep 17 00:00:00 2001 From: Leynos Date: Fri, 27 Jun 2025 07:25:05 +0100 Subject: [PATCH 1/2] Remove stray citation markers --- docs/multi-packet-and-streaming-responses-design.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/multi-packet-and-streaming-responses-design.md b/docs/multi-packet-and-streaming-responses-design.md index c9d09461..065e7a41 100644 --- a/docs/multi-packet-and-streaming-responses-design.md +++ b/docs/multi-packet-and-streaming-responses-design.md @@ -40,7 +40,7 @@ The implementation must satisfy the following core requirements: The cornerstone of this design is a move to a purely **declarative streaming model**. Instead of providing handlers with an imperative `FrameSink` to push frames into, handlers will declaratively return a description of the entire -response. 5 This approach significantly simplifies the API surface, improves +response. This approach significantly simplifies the API surface, improves testability, and eliminates a class of resource management issues associated with sink-based designs. @@ -62,7 +62,7 @@ explicit channel management. To provide an ergonomic way for developers to generate streams using imperative-style logic (e.g., inside a `for` loop), `wireframe` will adopt and -recommend the `async-stream` crate. 9 This crate provides macros ( +recommend the `async-stream` crate. This crate provides macros ( `stream!` and `try_stream!`) that transform imperative `yield` statements into a fully compliant `Stream` object. This gives developers the best of both worlds: From 1e293e899b13ce72918e471168ac4af4a9db5208 Mon Sep 17 00:00:00 2001 From: Leynos Date: Fri, 27 Jun 2025 12:55:41 +0100 Subject: [PATCH 2/2] Fix async-stream doc parenthetical --- docs/multi-packet-and-streaming-responses-design.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/multi-packet-and-streaming-responses-design.md b/docs/multi-packet-and-streaming-responses-design.md index 065e7a41..a97dc71f 100644 --- a/docs/multi-packet-and-streaming-responses-design.md +++ b/docs/multi-packet-and-streaming-responses-design.md @@ -62,11 +62,10 @@ explicit channel management. To provide an ergonomic way for developers to generate streams using imperative-style logic (e.g., inside a `for` loop), `wireframe` will adopt and -recommend the `async-stream` crate. This crate provides macros ( - -`stream!` and `try_stream!`) that transform imperative `yield` statements into a -fully compliant `Stream` object. This gives developers the best of both worlds: -the intuitive feel of imperative code generation without the API complexity of a +recommend the `async-stream` crate. This crate provides macros (`stream!` and +`try_stream!`) that transform imperative `yield` statements into a fully +compliant `Stream` object. This gives developers the best of both worlds: the +intuitive feel of imperative code generation without the API complexity of a separate `FrameSink` type. ## 4. Public API Surface