improve documentation truncation behavior #728
Merged
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.
You can see that some shapes get quite long, CLI example: https://docs.aws.amazon.com/cli/latest/reference/quicksight/update-template.html
JSv3 API example: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-quicksight/classes/updatetemplatecommand.html
This PR aims to improve the recently implemented structural hint doc generation.
more aggressive truncation for repeated shapes
truncated item shows the target shape name instead of its entire structure
example, original shape appearance with name tag and then subsequent repeated shape truncation
JSv3 diff in https://github.com/aws/aws-sdk-js-v3/pull/4585/files