Skip to content

chore(docs): move description block before deprecated tag #1516

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

Merged
merged 1 commit into from
Jan 29, 2025
Merged

chore(docs): move description block before deprecated tag #1516

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
2 changes: 1 addition & 1 deletion ...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 @@ -266,7 +266,7 @@ boolean writeMemberDocs(Model model, MemberShape member) {
docs = docs.replace("{", "\\{")
.replace("}", "\\}");
if (member.getTrait(DeprecatedTrait.class).isPresent() || isTargetDeprecated(model, member)) {
docs = "@deprecated\n\n" + docs;
docs = docs + "\n\n@deprecated";
Copy link
Contributor

@kuhe kuhe Jan 29, 2025

Choose a reason for hiding this comment

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

this is needed since the tsdoc does not support explicit @description block like jsdoc. tsdoc uses only the implied description block and it must come first in the docblock order.

}
docs = addReleaseTag(member, docs);
writeDocs(docs);
Expand Down