Skip to content

fix(docs): improve deprecatedTrait with default description #1541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): improve deprecatedTrait with default description #1541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,9 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> 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;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

String deprecationMessage = deprecatedTrait.getMessage()
    .orElse("see description.");

String deprecationAnnotation = "@deprecated " + deprecationMessage;

docs = docs + "\n\n" + deprecationAnnotation;

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

goal is to always have a message after the @deprecated annotation so that any text coming after is not mistakenly interpreted to be the deprecation message.

the tsdoc spec requires that @deprecated annotation comes with a message.

.map(msg -> " " + msg)
.orElse(" see description");
String deprecationString = deprecatedTrait.getMessage().isPresent() ? "@deprecated" + deprecationMessage : "@deprecated";
docs = docs + "\n\n" + deprecationString;
}
docs = preprocessor.apply(docs);
Expand Down