fix(jsii-pacmak): escape documentation in all positions #4096
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
The [AWS::Personalize::Solution.PerformAutoML]( https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-solution.html#cfn-personalize-solution-performautoml) property immediately starts with an admonition, which in our system gets translated to: ``` /** * > Admonition! * * Normal description of the property */ ``` We weren't expecting complex markup in the 'summary' section of the JavaDocs, so we weren't escaping it, and this was making javadoc sad: ``` /software/amazon/awscdk/services/personalize/CfnSolution.java:2211: error: bad use of '>' * > We don't recommend enabling automated machine learning. ``` Be sure to properly do MarkDown -> HTML conversion everywhere.
|
Well we have a lot of fallout from this change, so can't merge it yet :( |
RomainMuller
approved these changes
May 16, 2023
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
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.
The AWS::Personalize::Solution.PerformAutoML property immediately starts with an admonition, which in our system gets translated to:
We weren't expecting complex markup in the 'summary' section of the JavaDocs, so we weren't escaping it, and this was making javadoc sad:
Be sure to properly do MarkDown -> HTML conversion everywhere.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.