Skip to content

Commit 0094071

Browse files
committed
fix(docs): improve deprecatedTrait with default description
1 parent ee3ec22 commit 0094071

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,9 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
225225
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
226226
DeprecatedTrait deprecatedTrait = shape.expectTrait(DeprecatedTrait.class);
227227
String deprecationMessage = deprecatedTrait.getMessage()
228-
.map(msg -> " " + msg)
229-
.orElse("");
230-
String deprecationString = "@deprecated" + deprecationMessage;
228+
.map(msg -> " " + msg)
229+
.orElse(" see description");
230+
String deprecationString = deprecatedTrait.getMessage().isPresent() ? "@deprecated" + deprecationMessage : "@deprecated";
231231
docs = docs + "\n\n" + deprecationString;
232232
}
233233
docs = preprocessor.apply(docs);

0 commit comments

Comments
 (0)