chore(docs): move description block before deprecated tag #1516
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aBurmeseDev
changed the title
kuhe
reviewed
Jan 29, 2025
| @@ -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"; | |||
There was a problem hiding this comment.
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.
kuhe
approved these changes
Jan 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Resource: https://tsdoc.org/pages/tags/deprecated/
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.