Skip to content

Commit ae49717

Browse files
authored
Add deprecation message in shape docs (#1209)
1 parent a53fe36 commit ae49717

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,11 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
190190
.replace("}", "\\}");
191191
docs = preprocessor.apply(docs);
192192
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
193-
docs = "@deprecated\n\n" + docs;
193+
DeprecatedTrait deprecatedTrait = shape.getTrait(DeprecatedTrait.class).get();
194+
String deprecationMessage = deprecatedTrait.getMessage().orElse("");
195+
String deprecationString = "@deprecated"
196+
+ (deprecationMessage.isEmpty() ? "" : " " + deprecationMessage);
197+
docs = deprecationString + "\n\n" + docs;
194198
}
195199
docs = addReleaseTag(shape, docs);
196200
writeDocs(docs);

0 commit comments

Comments
 (0)