improve documentation on event stream client operaitons

smithy-lang · Jul 24, 2024 · 74ff567 · 74ff567
1 parent 85a993a
commit 74ff567
Show file tree

Hide file tree

Showing 21 changed files with 171 additions and 94 deletions.
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/auth.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/auth.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/client.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/client.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/config.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/config.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/endpoint.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/endpoint.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/event_stream.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/event_stream.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/plugins/global_config.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/plugins/global_config.rb
diff --git a/codegen/projections/cbor_event_streams/lib/cbor_event_streams/types.rb b/codegen/projections/cbor_event_streams/lib/cbor_event_streams/types.rb
diff --git a/codegen/projections/cbor_event_streams/sig/cbor_event_streams/auth.rbs b/codegen/projections/cbor_event_streams/sig/cbor_event_streams/auth.rbs
diff --git a/codegen/projections/cbor_event_streams/sig/cbor_event_streams/config.rbs b/codegen/projections/cbor_event_streams/sig/cbor_event_streams/config.rbs
diff --git a/codegen/projections/cbor_event_streams/sig/cbor_event_streams/endpoint.rbs b/codegen/projections/cbor_event_streams/sig/cbor_event_streams/endpoint.rbs
diff --git a/codegen/projections/white_label/lib/white_label/client.rb b/codegen/projections/white_label/lib/white_label/client.rb
diff --git a/codegen/projections/white_label/lib/white_label/event_stream.rb b/codegen/projections/white_label/lib/white_label/event_stream.rb
diff --git a/codegen/projections/white_label/lib/white_label/types.rb b/codegen/projections/white_label/lib/white_label/types.rb
diff --git a/...codegen/src/main/java/software/amazon/smithy/ruby/codegen/generators/ClientGenerator.java b/...codegen/src/main/java/software/amazon/smithy/ruby/codegen/generators/ClientGenerator.java
@@ -83,7 +83,7 @@ public void render() {
                     .writeRequireRelativeAdditionalFiles(additionalFiles)
                     .openBlock("module $L", settings.getModule())
                     .call(() -> new ShapeDocumentationGenerator(
-                            model, writer, symbolProvider, context.service()).render())
+                            context, writer, symbolProvider, context.service()).render())
                     .openBlock("class Client < $T", Hearth.CLIENT)
                     .write("")
                     .call(() -> renderClassRuntimePlugins(writer))
@@ -201,7 +201,7 @@ private void renderOperation(RubyCodeWriter writer, OperationShape operation) {
 
         writer
                 .write("")
-                .call(() -> new ShapeDocumentationGenerator(model, writer, symbolProvider, operation).render())
+                .call(() -> new ShapeDocumentationGenerator(context, writer, symbolProvider, operation).render())
                 .call(() -> {
                     if (isStreaming) {
                         writer
@@ -250,7 +250,7 @@ private void renderEventStreamOperation(
 
         writer
                 .write("")
-                .call(() -> new ShapeDocumentationGenerator(model, writer, symbolProvider, operation).render())
+                .call(() -> new ShapeDocumentationGenerator(context, writer, symbolProvider, operation).render())
                 .openBlock("def $L(params = {}, options = {})", operationName)
                 .write("middleware_opts = {}")
                 .write("middleware_opts[:event_stream_handler] = options.delete(:event_stream_handler)")

diff --git a/...en/src/main/java/software/amazon/smithy/ruby/codegen/generators/EventStreamGenerator.java b/...en/src/main/java/software/amazon/smithy/ruby/codegen/generators/EventStreamGenerator.java
@@ -54,7 +54,7 @@ protected String getModule() {
     }
 
     public void render() {
-        // TODO: Render documentation and examples for these
+        // TODO: Render RBS For these
         write(writer -> {
             writer
                     .preamble()
@@ -192,8 +192,8 @@ private void renderEventStreamOutputDocs(RubyCodeWriter writer, OperationShape o
         String operationName = RubyFormatter.toSnakeCase(symbolProvider.toSymbol(operation).getName());
 
         writer
-                .write("# Output class returned from {Client#$L}", operationName)
-                .write("# and allowing async sending (signaling) of input events.")
+                .write("# Output returned from {Client#$L}", operationName)
+                .write("# and used to signal (send) async input events.")
                 .writeYardExample("Basic Usage", renderEventStreamOutputExample(operation));
     }
 
@@ -240,7 +240,7 @@ private void renderSignalMethodDocs(RubyCodeWriter writer, MemberShape memberSha
         String eventShapeName = symbolProvider.toSymbol(eventShape).getName();
 
         String paramsDocString = """
-                Request parameters for this operation.
+                Request parameters for signaling this event.
                 See {Types::%s#initialize} for available parameters.
                 """.formatted(eventShapeName);