fix(docs): improve deprecatedTrait with default description #1541
Conversation
This file contains hidden or 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
kuhe
reviewed
Mar 5, 2025
| @@ -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; | |||
There was a problem hiding this comment.
String deprecationMessage = deprecatedTrait.getMessage()
.orElse("see description.");
String deprecationAnnotation = "@deprecated " + deprecationMessage;
docs = docs + "\n\n" + deprecationAnnotation;
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.