chore(assertions): misformatted doc string causes generated docs to cutoff information #27392

[stm29]

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

* @param logicalId the name of the parameter. Provide `'*'` to match all parameters in the template.

creates this following format in .jsii assembly

              "docs": {
                "remarks": "Provide '*' to match all parameters in the template.",
                "summary": "the name of the parameter."
              },

Remarks section is created by jsii, when @remarks is mentioned or it takes anything after first paragraph. (after first dot)
Reference:
https://github.com/aws/jsii/blob/50e6c47fb873fab894e3779bafb0e84c31287839/packages/%40jsii/spec/src/assembly.ts#L313-L321

Decision on approach

1. fix it from jsii / from our documentation portal side, by modifying configuration to show remarks also in portal.
2. convert this detail as summary by keeping it in first paragraph. [This PR implements this]

Description of changes

Changed

@param logicalId the name of the parameter. Provide `'*'` to match all parameters in the template.

To, NOTE, . P --> , p

@param logicalId the name of the parameter, provide `'*'` to match all parameters in the template.

Description of how you validated changes

1. $ npx lerna run build --scope=aws-cdk-lib --skip-nx-cache
2. Ran build inside aws-cdk-lib --> username@aws-cdk-lib$ yarn build, this created .jsii file with compressed form.
3. Now ran yarn jsii --> this uncompresses .jsii file and creates exact doc content inside .jsii file.
4. Checked, everything is placed inside summary

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[aws-cdk-automation]

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.

[stm29]

Exemption Request , as only doc string changes.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

[mergify]

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-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 3079c70
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

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).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.