(assertions): misformatted doc string causes generated docs to cut off information

[jishi]

Describe the issue

I was about to file a PR to clarify syntax for the Template.findParameters() call, but when I looked at the source, the documentation for parameters has been correct for 2 years. See this:

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/assertions/lib/template.ts#L183

However, the latest documentation for this method is missing the * info. Isn't the online documentation generated from the comments? Why is the crucial information about this omitted here?

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.assertions.Template.html#findwbrparameterslogicalid-props

[scanlonp]

I suspect that the docstring below the @param tags is messing up the doc generation. Looks like an easy fix, but this problem is somewhat widespread in that file.

[0scvr]

I'd be willing to work on this and submit a PR.

[daschaa]

@scanlonp Is there a way to generate the docs locally to test it?

[Exter-dg]

I would like to work on this. As someone mentioned, is there a way to generate docs locally and test the changes? How are docs generated, I wasn't able to figure that out from the code

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

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