From 00940718072272882192541ac1f141b2497e96b1 Mon Sep 17 00:00:00 2001 From: John Lwin Date: Mon, 3 Mar 2025 21:04:43 -0800 Subject: [PATCH] fix(docs): improve deprecatedTrait with default description --- .../amazon/smithy/typescript/codegen/TypeScriptWriter.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java index c183b7d2054..5e2ab58577b 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java @@ -225,9 +225,9 @@ boolean writeShapeDocs(Shape shape, UnaryOperator preprocessor) { if (shape.getTrait(DeprecatedTrait.class).isPresent()) { DeprecatedTrait deprecatedTrait = shape.expectTrait(DeprecatedTrait.class); String deprecationMessage = deprecatedTrait.getMessage() - .map(msg -> " " + msg) - .orElse(""); - String deprecationString = "@deprecated" + deprecationMessage; + .map(msg -> " " + msg) + .orElse(" see description"); + String deprecationString = deprecatedTrait.getMessage().isPresent() ? "@deprecated" + deprecationMessage : "@deprecated"; docs = docs + "\n\n" + deprecationString; } docs = preprocessor.apply(docs);