Skip to content
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.

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

fix(jsii-pacmak): escape documentation in all positions #4096

Merged
merged 9 commits into from
May 17, 2023

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented May 12, 2023

The AWS::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.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

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.
@rix0rrr rix0rrr requested a review from a team May 12, 2023 14:29
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 12, 2023
@rix0rrr rix0rrr marked this pull request as draft May 12, 2023 14:30
@rix0rrr
Copy link
Contributor Author

rix0rrr commented May 12, 2023

Well we have a lot of fallout from this change, so can't merge it yet :(

@rix0rrr rix0rrr marked this pull request as ready for review May 15, 2023 13:28
@mergify
Copy link
Contributor

mergify bot commented 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!

@mergify mergify bot added the pr/ready-to-merge This PR is ready to be merged. label May 16, 2023
@mergify
Copy link
Contributor

mergify bot commented May 16, 2023

Merging (with squash)...

@mergify
Copy link
Contributor

mergify bot commented May 17, 2023

Merging (with squash)...

@mergify mergify bot merged commit 6a2248d into main May 17, 2023
27 checks passed
@mergify mergify bot deleted the huijbers/missing-escapes branch May 17, 2023 14:28
@mergify mergify bot removed the pr/ready-to-merge This PR is ready to be merged. label May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants