chore(assertions): misformatted doc string causes generated docs to cutoff information #27392#31199
chore(assertions): misformatted doc string causes generated docs to cutoff information #27392#31199mergify[bot] merged 2 commits intoaws:mainfrom
Conversation
aws-cdk-automation
left a comment
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
|
Exemption Request , as only doc string changes. |
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Comments on closed issues and PRs are hard for our team to see. |
Issue #27392
Closes #27392
Reason for this change
Following Comment format,
aws-cdk/packages/aws-cdk-lib/assertions/lib/template.ts
Line 183 in aca9027
creates this following format in .jsii assembly
Remarks section is created by jsii, when
@remarksis mentioned or it takes anything after first paragraph. (after firstdot)Reference:
https://github.com/aws/jsii/blob/50e6c47fb873fab894e3779bafb0e84c31287839/packages/%40jsii/spec/src/assembly.ts#L313-L321
Decision on approach
Description of changes
Changed
To, NOTE, . P --> , p
Description of how you validated changes
$ npx lerna run build --scope=aws-cdk-lib --skip-nx-cacheusername@aws-cdk-lib$ yarn build, this created .jsii file with compressed form.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license